Elite Wiki - User contributions [en]

EscortDeck

2022-12-14T17:05:12Z

Dybal: /* Quick Facts */

Build up your escort fleet and hold on an external deck attached to your ship.

First you must buy Escort Deck equipment then you will see an attached platform in your aft view.

[[Image:Ed9.png|right]]

=== Ship rules ===

A deck provide 4 landing pads for escort ships with '''max. 130t''' mass, 70m width, 29m height and 135m length: Adder, Asp, Cobra Mark I, Constrictor, Fer-de-Lance, Gecko, Mamba, Moray, Sidewinder and Viper.

If your ship is '''over 130t''' mass like Cobra Mark III then can hold another two small ships like Adders (max. 15m height, 39m width and 65m length) on the sides of the deck.

The mass of your escort must be less than '''40%''' of your ship's mass. For example an Asp (75t) can hold 4 small escorts below 30t: Adder, Gecko or Sidewinder. You should use a ship over 40t mass to be able to use Adders (16t) as escorts. Ships below 30t mass can not get Escort Deck.

Beware of replacing your large ship to a smaller one, all of your escorts will be salvaged which isn't fit into the smaller limits.

=== Wide deck ===

Ships over '''260t''' like Python receive wider deck variant to hold escorts up to 95m width like Krait or [http://aegidian.org/bb/viewtopic.php?f=2&t=16926&hilit=Tiger+Ray&start=45#p229820 Tiger Ray].

[[Image:Ed5.png]]

=== Purchasing escorts ===

You can buy escorts in the ship outfitting (F3) screen. These are not available in the local shipyard but ordered from a remote owner so your time will forwarding a lot if you buy one, but in this way you can buy advanced ships in the low tech worlds also.

Name Cost Energy Recharg Speed Pitch Mass t Eqipment
Adder 80000 85 2 240 2 16 Pulse laser, Injectors, Shield booster
Asp 400000 350 4 400 1 75 Beam Lasers forward and aft, ECM, Injectors, Shield booster
Gecko 100000 250 4 300 1.5 25 Beam Laser, ECM
Sidew. 76000 240 2 370 1.6 26 Beam Laser
Viper 600000 180 4 320 1.8 34 Military Laser, ECM, Injectors, Shield booster and enhancer

* '''Adder Escort''' can utilize the mini landing pads on the sides of your Escort Deck. This special design can hold a Pulse Laser only and no cargo but has Injectors and Shield Boosters.
* '''Asp Escort''' is the fastest and most enduring core escort ship what you can purchase with forward and aft Beam Lasers, ECM, Injectors and Shield Boosters.
* '''Gecko Escort''' is a pirate ship so not available at main stations but strong, small and equipped with a Beam Laser and ECM.
* '''Sidewinder Escort''' is a small and agile ship, useful if your ship isn't large enough to hold [[EscortDeck#Heavy_escorts|heavy escorts]]. Equipped with a Beam Laser but can not use Injectors.
* '''Viper Escort''' is an used GalCop ship, available at main stations only and if your status is clean. This old ship has much lower speed and energy than the modern Interceptors but contain many military equipments.

There are very good pirate escort ships (more if you install [[EscortPack]]) but these are not purchaseable in main stations: you must force to eject the pilot or find in the outfitting list '''in alternative stations'''.

There are rumors about ace '''sniper''' pilots in pirate stations with better ships than an Asp, but these surely costs more than 1MCr if you want to hire them into your escort fleet.

=== Derelicts ===

You can pick up derelict ships: put your target lock on, go nearer than 500m and with less than 100m/s speed difference. If you can not target it (due to the target has jamming device) then you can collide very slowly to trigger the pickup.

If an "usable" message shown in your console when target a derelict ship ([[CombatMFD|Combat MFD]] show it also) then you can use this ship as your escort, else transfer it to a dock on your deck and you will get some money for the '''salvage'''.

If you have [[Towbar]] OXP then you will get reputation also for the delivered salvage.

[[Image:Ed17.png]]

=== Heavy escorts ===

There are heavy escorts around 120t mass, these are multipurpose ships modified for escort jobs which mean removed cargo capacity and some bonuses (please install [[EscortPack]] OXP to get these).

You need a ship with '''325t''' mass to be able to use all escorts up to the maximal 130t, so an Anaconda or special (OXP) Pythons can hold heavy escorts but a Cobra Mark III (215t) or a Boa (182t) can't.

=== Usage ===

You can prime Escort Deck with Shift+N then activate with "n" key to launch or call back your escorts. The mode key "b" select a single escort for launch or callback. There is an auto launch if you enter into red alert and auto callback when changed to green.

You can prevent the launch of any ship if you select it by the mode key then activate once only: the first press will change the status to "LOCKED". The second activate will remove the lock and launch it, but you can call back instantly with a third keypress if you want to stay on the deck without the lock.

There is an auto launch if you enter into red alert and auto callback when changed to green.

There is a Multi-Function Display of Escort Deck, you can turn it on using the ":" and ";" keys.

[[Image:Edmfd.png]]

This show the list of current escorts, a "->" mark before the selected one, name, energy, fuel (if this escort has working Injectors), distance, bearing (^> mean up left) and activity:

ATTACK: Attack a hostile ship (your target first)
DECK: Landed on the deck
FLEE: Flee from a missile or recover some energy (from 40% to 80%)
FOLLOW: Follow your ship at 2km range
GOTO: Go to a hostile ship using Injectors if available until arrive within Beam Laser range (15km)
INJECT: Attack using Injectors until distance is over 10km
LANDING: Landing approach, will not do anything else until landed
LOCKED: Stay on the deck and will not launch with the other ships
SALVAGE: Unusable ship, will be salvaged in the next dock for a few thousand credits
SNIPER: Sniper attack, need a forward laser over 15km range, like Military Laser

You can pick up a new escort even if there is no more free landing pads listed on your MFD if you select a pad and maintain a target lock on the new ship when try to land or an escort is not in your deck. In these cases the old one will be replaced and you will find it bit farther behind your ship.

The released escort will follow you (if it is not derelict) while you stay within the same system and don't take a rest (reload the game), but will not defend you by itself. So you can pick up a derelict ship by replacing one of your escorts, transfer it into a station for payment, then leave the station and relock your old escort to the deck.

If you dock or enter into a wormhole while some of your escorts are not in your deck then those that is within your scanner range will be docked also. Others can be lost, especially if travelled far from you.

If you want to exchange the positions of two escorts on your deck then do these in order:
1. Select an escort by mode key (b) if Escort Deck is primed with Shift+N and all escorts landed.
2. Launch it with the activate key (n) and wait a few seconds for it to go out of landing distance.
3. Press activate (n) again to order it back to landing and turn your ship to keep it in your screen.
4. Press mode (b) until you select the second escort to flag the wanted landing position.
5. Put your target lock to the launched ship: press "r" and aim well with your crosshairs.
6. Wait for landing when the exchange will be done.

The MFD can show the ship on [[Towbar]] in the last line, maked as T: . You can release the towed ship by selecting and activating it in this MFD. If no ship on your Towbar then show the maximal mass which your ship can tow (1.6 times of the mass of your ship).

Your escorts will be refuelled when you buy fuel for your ship.

Cost: 2000.0 Cr.
Techlevel: 1

== Escort Deck XL ==

If your ship is over '''400t''' like an Anaconda then you can buy XL deck instead of the common deck can hold '''8 escorts''' behind you, but the mass limit is lower: max. '''60t''', so you can't use Asp and heavy escort ships.

If you have Towbar then you can't pick up any ship there due to the long XL deck occupy the same space behind you. The simple escort deck is shorter and Towbar compatible so if you plan to salvage larger ships than small escorts then you should choose the normal deck.

Warning: your ship can be "uber" if you use 8 escorts, so if you want limit yoursef then stick with the smaller deck and avoid the XL variant.

[[Carriers]] can hold '''10 escorts''' on the internal XL deck (the "neck") and the mass limit is 130t as in the normal deck. Moreover the '''first two pads''' (on the top) can hold '''wider and heavier''' ships up to '''378t''' (40% of Carriers' mass) and 130x35x95m including Cobra Mark III, Krait and other large ships also. This is even more "uber" but intentionally: a Carrier should be able to hold stronger fleet than others.

Cost: 2000.0 Cr.
Techlevel: 1

== Interface ==

In F4 screen you can view, '''rename''' and '''salvage''' your current escorts. Moreover if [[Hyperspace Hangar]] is installed then you can '''buy esorts from the main shipyard''' (F3F3) using the following steps:

1. Buy a small ship from a shipyard which fit into your deck and save your main ship into the Hyperspace Hangar.
2. Equip it for combat as you wish, just avoid player-only tools like Railgun.
3. Save the escort into the hangar by switching into your main ship.
4. Go to the Escort Deck interface, select an empty deck and get the escort from the hangar.

The hangar is usable as a temporary storage to '''rearrange''' your escorts as well as '''fix damaged equipments''' or '''buy new ones''', just store your main ship into the hangar:

1. Select a ship in the EscortDeck Interface.
2. Put into Hyperspace Hangar.
3. Go into the interface of Hyperspace Hangar and switch into the stored escort.
4. Equip or fix it.
5. Switch back into your main ship in the hangar interface.
6. Go to the EscortDeck interface, select an empty deck and get your escort from the hangar.

If you acquired an OXP escort ship which is not designed for player then you can not switch into.

[[Image:Ed18.png|1000px]]

You can upgrade the whole escort if you buy another ship in shipyard (F3F3) while you are switched into an escort. The old ship will be counted into the cost of the new one, regardless of you found (or just forced to eject) in the deep space.

The trade-in value (75% of ship price) is displayed in the interface (see the top left corner in the screenshot above) due to this reason. But you are not able to sell an escort and get this big money directly (to keep up some balance).

== Ship mass table ==

Adder 16
Moray 51
Cobra Mk I 52
Fer-de-Lance 53
Asp 75
Boa 182
Cobra Mk III 215
Boa2 216
Python 267
Anaconda 438

NPC:
Gecko 25
Sidewinder 26
Constrictor 28
Viper 34
Mamba 36
Krait 94

== Escort Deck variants ==

You will get one of the following variants depending on the mass of your ship.

* Below 30t: You can not use any decks.

* 30t-130t: '''Small deck''' without side pads.
[[Image:Ed14.png]]

* 130t-260t: '''Normal deck''' with side pads for two additional mini escorts (Adder).
[[Image:Ed8.png]]

* 260t-: '''Wide deck''' which can hold ships up to 95m width (Krait).
[[Image:Ed2.png]]

* 400t-: You can choose either the wider deck or '''XL deck'''.
[[Image:Ed11.png]]

* [[Carriers]] can hold the most powerful escort fleet, using the big hull as a deck.

[[Image:Carriers4.png]]

For more information see the [http://aegidian.org/bb/viewtopic.php?f=4&t=17009 regarding discussuion].

== Screenshots ==

Flying peacefully:

[[Image:Ed10.png]]

Escorts released to counterattack a bad guy:

[[Image:Ed16.png|1000px]]

== License ==

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

The 3D models of decks are derived from Leviathan Platform in Aquatics OXP, thanks to Thargoid and P.A. Groove.

Escort locked sound is equal with Towbar locked which is based on bgs-m_fx_shipyard1.ogg in BGS OXP.

== Download ==

[[Media:EscortDeck-1.12.oxz|EscortDeck-1.12.oxz]].

Recommended: [[EscortPack]], [[Carriers]], [[Towbar]], [[Library OXP]].

Old versions:

[[Media:EscortDeck_1.11.oxz|EscortDeck_1.11.oxz]] (downloaded {{#downloads:EscortDeck_1.11.oxz}} times)

[[Media:EscortDeck.1.9.oxz|EscortDeck.1.9.oxz]] (downloaded {{#downloads:EscortDeck.1.9.oxz}} times).

[[Media:EscortDeck.1.8.oxz|EscortDeck.1.8.oxz]] (downloaded {{#downloads:EscortDeck.1.8.oxz}} times).

[[Media:EscortDeck.1.7.oxz|EscortDeck.1.7.oxz]] (downloaded {{#downloads:EscortDeck.1.7.oxz}} times).

[[Media:EscortDeck.1.6.oxz|EscortDeck.1.6.oxz]] (downloaded {{#downloads:EscortDeck.1.6.oxz}} times).

[[Media:EscortDeck.1.5.oxz|EscortDeck.1.5.oxz]] (downloaded {{#downloads:EscortDeck.1.5.oxz}} times).

[[Media:EscortDeck.1.4.oxz|EscortDeck.1.4.oxz]] (downloaded {{#downloads:EscortDeck.1.4.oxz}} times).

[[Media:EscortDeck.1.3.oxz|EscortDeck.1.3.oxz]] (downloaded {{#downloads:EscortDeck.1.3.oxz}} times).

[[Media:EscortDeck.1.2.oxz|EscortDeck.1.2.oxz]] (downloaded {{#downloads:EscortDeck.1.2.oxz}} times).

[[Media:EscortDeck.1.1.oxz|EscortDeck.1.1.oxz]] (downloaded {{#downloads:EscortDeck.1.1.oxz}} times).

[[Media:EscortDeck.1.0.oxz|EscortDeck.1.0.oxz]] (downloaded {{#downloads:EscortDeck.1.0.oxz}} times).

== Changelog ==
2022.12.14. v1.12 Updates escorts' AIs and scripts to avoid closing too fast at landing.
Increases TL for equipments and escort ships.
Adds configuration for launching/calling back when going in/out of red alert.
Adds configuration for base usable derelict probability.
Configuration via Svengali's Library 'Config for AddOns'.
Takes NPC_equipmentDamage OXP's equipment damage into account for usable derelict probability
calculation (reduces base probability of being usable).
Makes Towbar not salvage usable derelicts if Hyperspace Hangar is installed.
Optimizes mass factor (degradation of ship maneuverability by ship's total mass) updates.
Tests for a functional escortdeck in the player ship in event handlers.
Updates shipAtackedOther event handler to handle Laser Reductor presence and be compatible with use
as a ship event handler for the escorts.
Puts a random factor into awarding equipment to usable derelicts, and those equipment could be damaged.
Uses ShipStorageHelper OXP for ship serialization if installed.
Sets event handlers in the escorts' ship scripts to use Laser Reductor.
Fixes bug in scrolling along the pads in the MFD.
Makes Towbar's Tug Drone store usable derelicts in the Hyperspace Hangar.
Performance updates to FCB.
Adds status of escorts' shields to MFD.
Adds menu entry to refuel escort to EscortDeck Station Interface.
Sets current galaxy number and system ID to the shipdata array when storing an escort in Hyperspace Hangar.
2016.07.17. v1.11 Updated for Oolite 1.84 where player can not be the leader of a group.
2016.06.25. v1.9 Fixed long message bug at salvage without Towbar, thanks to Strato1.
Too heavy message is not repeated too often anymore.
Deck is drifting away after player died.
Improved landing code based on the similar part in [[Fighters]] OXP.
2016.03.13. v1.8 Interface menu display the names of ships in deck.
Fixed value in "you paid" message in costly non-main stations.
Aft [[Sniper Gun]] will not move the deck too far anymore, needed by Asp SG and Python SG.
Escort Deck can hold the long Asp SG and Fer-de-Lance SG, Wide Deck can hold Krait SG also.
Carrier top deck can hold Cobra Mark III SG, main deck can hold Krait SG.
Typo fix in shipdata, thanks to phkb.
2015.10.14. v1.7 Interface functions: rename, salvage, put into Hyperspace Hangar and get back.
2015.10.04. v1.6 Escort Deck Interface added into the F4 screen.
Deck positions can be locked to avoid launch of some ships.
Deck cost raised to 2000cr as suggested by Vincentz.
Escorts start with heat shield for sunskimming, requested by QCS.
Chance to find an usable derelict escort is reduced, salvage increased.
MFD show the ship on [[Towbar]] in the last line, maked as T: .
You can release the towed ship by selecting and activating it in MFD.
Show the mass of attached salvage ships on MFD.
Fixed for the change of weaponPositions to array in Oolite 1.83.
Escortship personality is restored from Oolite 1.81.
2015.04.14. v1.5 MFD show max. mass and sizes of empty decks depending on player ship.
Further increased distances on deck before Oolite 1.81.
Fixed maximum mass check of escorts, must below 40% of owner ship's mass.
Hard and Granite escorts counted with original mass (without double density).
Fixed equipment restore on escorts if depends on another equipment.
2015.04.11. v1.4 Collision fixes, needed before Oolite 1.81.
Granite ships on deck do not prevent hyperjump anymore.
From 1.81 slower steering and acceleration in proportion with the mass on deck.
2015.04.06. v1.3 Increased distance around player without Injectors to 5km, thanks to QCS.
Workaround against escort terminated by Witchpoint Beacon.
2015.03.20. v1.2 Refined escort landing sequence to prevent collisions, thanks to QCS.
Added a collisionException between the Witchpoint Beacon and escorts.
Fixed rollback price of unsuccessful escort purchese in Rock Hermits.
2015.01.20. v1.1 No escort launch at injector speeds nor autolaunch at maximum speed.
Fixed escort equipments after load game.
All escorts got a missile pylon to workaround a bug with Carriers' sit into feature.
Escort view positions added.
2015.01.11. v1.0 First release.

== Additions ==
*[[Escort Pack]] adds another 24 possible escorts to choose from

== Quick Facts ==
{{OXPLevel|0}}{{Infobox OXPb| title = EscortDeck
|version = 1.12
|release = 2022.12.14
|features = Personal escort fleet
|license = CC BY-NC-SA 4
|category = Activities OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=17009 BB-Link]
}}

EscortDeck

2022-12-14T17:04:47Z

Dybal: /* Changelog */

Build up your escort fleet and hold on an external deck attached to your ship.

First you must buy Escort Deck equipment then you will see an attached platform in your aft view.

[[Image:Ed9.png|right]]

=== Ship rules ===

A deck provide 4 landing pads for escort ships with '''max. 130t''' mass, 70m width, 29m height and 135m length: Adder, Asp, Cobra Mark I, Constrictor, Fer-de-Lance, Gecko, Mamba, Moray, Sidewinder and Viper.

If your ship is '''over 130t''' mass like Cobra Mark III then can hold another two small ships like Adders (max. 15m height, 39m width and 65m length) on the sides of the deck.

The mass of your escort must be less than '''40%''' of your ship's mass. For example an Asp (75t) can hold 4 small escorts below 30t: Adder, Gecko or Sidewinder. You should use a ship over 40t mass to be able to use Adders (16t) as escorts. Ships below 30t mass can not get Escort Deck.

Beware of replacing your large ship to a smaller one, all of your escorts will be salvaged which isn't fit into the smaller limits.

=== Wide deck ===

Ships over '''260t''' like Python receive wider deck variant to hold escorts up to 95m width like Krait or [http://aegidian.org/bb/viewtopic.php?f=2&t=16926&hilit=Tiger+Ray&start=45#p229820 Tiger Ray].

[[Image:Ed5.png]]

=== Purchasing escorts ===

You can buy escorts in the ship outfitting (F3) screen. These are not available in the local shipyard but ordered from a remote owner so your time will forwarding a lot if you buy one, but in this way you can buy advanced ships in the low tech worlds also.

Name Cost Energy Recharg Speed Pitch Mass t Eqipment
Adder 80000 85 2 240 2 16 Pulse laser, Injectors, Shield booster
Asp 400000 350 4 400 1 75 Beam Lasers forward and aft, ECM, Injectors, Shield booster
Gecko 100000 250 4 300 1.5 25 Beam Laser, ECM
Sidew. 76000 240 2 370 1.6 26 Beam Laser
Viper 600000 180 4 320 1.8 34 Military Laser, ECM, Injectors, Shield booster and enhancer

* '''Adder Escort''' can utilize the mini landing pads on the sides of your Escort Deck. This special design can hold a Pulse Laser only and no cargo but has Injectors and Shield Boosters.
* '''Asp Escort''' is the fastest and most enduring core escort ship what you can purchase with forward and aft Beam Lasers, ECM, Injectors and Shield Boosters.
* '''Gecko Escort''' is a pirate ship so not available at main stations but strong, small and equipped with a Beam Laser and ECM.
* '''Sidewinder Escort''' is a small and agile ship, useful if your ship isn't large enough to hold [[EscortDeck#Heavy_escorts|heavy escorts]]. Equipped with a Beam Laser but can not use Injectors.
* '''Viper Escort''' is an used GalCop ship, available at main stations only and if your status is clean. This old ship has much lower speed and energy than the modern Interceptors but contain many military equipments.

There are very good pirate escort ships (more if you install [[EscortPack]]) but these are not purchaseable in main stations: you must force to eject the pilot or find in the outfitting list '''in alternative stations'''.

There are rumors about ace '''sniper''' pilots in pirate stations with better ships than an Asp, but these surely costs more than 1MCr if you want to hire them into your escort fleet.

=== Derelicts ===

You can pick up derelict ships: put your target lock on, go nearer than 500m and with less than 100m/s speed difference. If you can not target it (due to the target has jamming device) then you can collide very slowly to trigger the pickup.

If an "usable" message shown in your console when target a derelict ship ([[CombatMFD|Combat MFD]] show it also) then you can use this ship as your escort, else transfer it to a dock on your deck and you will get some money for the '''salvage'''.

If you have [[Towbar]] OXP then you will get reputation also for the delivered salvage.

[[Image:Ed17.png]]

=== Heavy escorts ===

There are heavy escorts around 120t mass, these are multipurpose ships modified for escort jobs which mean removed cargo capacity and some bonuses (please install [[EscortPack]] OXP to get these).

You need a ship with '''325t''' mass to be able to use all escorts up to the maximal 130t, so an Anaconda or special (OXP) Pythons can hold heavy escorts but a Cobra Mark III (215t) or a Boa (182t) can't.

=== Usage ===

You can prime Escort Deck with Shift+N then activate with "n" key to launch or call back your escorts. The mode key "b" select a single escort for launch or callback. There is an auto launch if you enter into red alert and auto callback when changed to green.

You can prevent the launch of any ship if you select it by the mode key then activate once only: the first press will change the status to "LOCKED". The second activate will remove the lock and launch it, but you can call back instantly with a third keypress if you want to stay on the deck without the lock.

There is an auto launch if you enter into red alert and auto callback when changed to green.

There is a Multi-Function Display of Escort Deck, you can turn it on using the ":" and ";" keys.

[[Image:Edmfd.png]]

This show the list of current escorts, a "->" mark before the selected one, name, energy, fuel (if this escort has working Injectors), distance, bearing (^> mean up left) and activity:

ATTACK: Attack a hostile ship (your target first)
DECK: Landed on the deck
FLEE: Flee from a missile or recover some energy (from 40% to 80%)
FOLLOW: Follow your ship at 2km range
GOTO: Go to a hostile ship using Injectors if available until arrive within Beam Laser range (15km)
INJECT: Attack using Injectors until distance is over 10km
LANDING: Landing approach, will not do anything else until landed
LOCKED: Stay on the deck and will not launch with the other ships
SALVAGE: Unusable ship, will be salvaged in the next dock for a few thousand credits
SNIPER: Sniper attack, need a forward laser over 15km range, like Military Laser

You can pick up a new escort even if there is no more free landing pads listed on your MFD if you select a pad and maintain a target lock on the new ship when try to land or an escort is not in your deck. In these cases the old one will be replaced and you will find it bit farther behind your ship.

The released escort will follow you (if it is not derelict) while you stay within the same system and don't take a rest (reload the game), but will not defend you by itself. So you can pick up a derelict ship by replacing one of your escorts, transfer it into a station for payment, then leave the station and relock your old escort to the deck.

If you dock or enter into a wormhole while some of your escorts are not in your deck then those that is within your scanner range will be docked also. Others can be lost, especially if travelled far from you.

If you want to exchange the positions of two escorts on your deck then do these in order:
1. Select an escort by mode key (b) if Escort Deck is primed with Shift+N and all escorts landed.
2. Launch it with the activate key (n) and wait a few seconds for it to go out of landing distance.
3. Press activate (n) again to order it back to landing and turn your ship to keep it in your screen.
4. Press mode (b) until you select the second escort to flag the wanted landing position.
5. Put your target lock to the launched ship: press "r" and aim well with your crosshairs.
6. Wait for landing when the exchange will be done.

The MFD can show the ship on [[Towbar]] in the last line, maked as T: . You can release the towed ship by selecting and activating it in this MFD. If no ship on your Towbar then show the maximal mass which your ship can tow (1.6 times of the mass of your ship).

Your escorts will be refuelled when you buy fuel for your ship.

Cost: 2000.0 Cr.
Techlevel: 1

== Escort Deck XL ==

If your ship is over '''400t''' like an Anaconda then you can buy XL deck instead of the common deck can hold '''8 escorts''' behind you, but the mass limit is lower: max. '''60t''', so you can't use Asp and heavy escort ships.

If you have Towbar then you can't pick up any ship there due to the long XL deck occupy the same space behind you. The simple escort deck is shorter and Towbar compatible so if you plan to salvage larger ships than small escorts then you should choose the normal deck.

Warning: your ship can be "uber" if you use 8 escorts, so if you want limit yoursef then stick with the smaller deck and avoid the XL variant.

[[Carriers]] can hold '''10 escorts''' on the internal XL deck (the "neck") and the mass limit is 130t as in the normal deck. Moreover the '''first two pads''' (on the top) can hold '''wider and heavier''' ships up to '''378t''' (40% of Carriers' mass) and 130x35x95m including Cobra Mark III, Krait and other large ships also. This is even more "uber" but intentionally: a Carrier should be able to hold stronger fleet than others.

Cost: 2000.0 Cr.
Techlevel: 1

== Interface ==

In F4 screen you can view, '''rename''' and '''salvage''' your current escorts. Moreover if [[Hyperspace Hangar]] is installed then you can '''buy esorts from the main shipyard''' (F3F3) using the following steps:

1. Buy a small ship from a shipyard which fit into your deck and save your main ship into the Hyperspace Hangar.
2. Equip it for combat as you wish, just avoid player-only tools like Railgun.
3. Save the escort into the hangar by switching into your main ship.
4. Go to the Escort Deck interface, select an empty deck and get the escort from the hangar.

The hangar is usable as a temporary storage to '''rearrange''' your escorts as well as '''fix damaged equipments''' or '''buy new ones''', just store your main ship into the hangar:

1. Select a ship in the EscortDeck Interface.
2. Put into Hyperspace Hangar.
3. Go into the interface of Hyperspace Hangar and switch into the stored escort.
4. Equip or fix it.
5. Switch back into your main ship in the hangar interface.
6. Go to the EscortDeck interface, select an empty deck and get your escort from the hangar.

If you acquired an OXP escort ship which is not designed for player then you can not switch into.

[[Image:Ed18.png|1000px]]

You can upgrade the whole escort if you buy another ship in shipyard (F3F3) while you are switched into an escort. The old ship will be counted into the cost of the new one, regardless of you found (or just forced to eject) in the deep space.

The trade-in value (75% of ship price) is displayed in the interface (see the top left corner in the screenshot above) due to this reason. But you are not able to sell an escort and get this big money directly (to keep up some balance).

== Ship mass table ==

Adder 16
Moray 51
Cobra Mk I 52
Fer-de-Lance 53
Asp 75
Boa 182
Cobra Mk III 215
Boa2 216
Python 267
Anaconda 438

NPC:
Gecko 25
Sidewinder 26
Constrictor 28
Viper 34
Mamba 36
Krait 94

== Escort Deck variants ==

You will get one of the following variants depending on the mass of your ship.

* Below 30t: You can not use any decks.

* 30t-130t: '''Small deck''' without side pads.
[[Image:Ed14.png]]

* 130t-260t: '''Normal deck''' with side pads for two additional mini escorts (Adder).
[[Image:Ed8.png]]

* 260t-: '''Wide deck''' which can hold ships up to 95m width (Krait).
[[Image:Ed2.png]]

* 400t-: You can choose either the wider deck or '''XL deck'''.
[[Image:Ed11.png]]

* [[Carriers]] can hold the most powerful escort fleet, using the big hull as a deck.

[[Image:Carriers4.png]]

For more information see the [http://aegidian.org/bb/viewtopic.php?f=4&t=17009 regarding discussuion].

== Screenshots ==

Flying peacefully:

[[Image:Ed10.png]]

Escorts released to counterattack a bad guy:

[[Image:Ed16.png|1000px]]

== License ==

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

The 3D models of decks are derived from Leviathan Platform in Aquatics OXP, thanks to Thargoid and P.A. Groove.

Escort locked sound is equal with Towbar locked which is based on bgs-m_fx_shipyard1.ogg in BGS OXP.

== Download ==

[[Media:EscortDeck-1.12.oxz|EscortDeck-1.12.oxz]].

Recommended: [[EscortPack]], [[Carriers]], [[Towbar]], [[Library OXP]].

Old versions:

[[Media:EscortDeck_1.11.oxz|EscortDeck_1.11.oxz]] (downloaded {{#downloads:EscortDeck_1.11.oxz}} times)

[[Media:EscortDeck.1.9.oxz|EscortDeck.1.9.oxz]] (downloaded {{#downloads:EscortDeck.1.9.oxz}} times).

[[Media:EscortDeck.1.8.oxz|EscortDeck.1.8.oxz]] (downloaded {{#downloads:EscortDeck.1.8.oxz}} times).

[[Media:EscortDeck.1.7.oxz|EscortDeck.1.7.oxz]] (downloaded {{#downloads:EscortDeck.1.7.oxz}} times).

[[Media:EscortDeck.1.6.oxz|EscortDeck.1.6.oxz]] (downloaded {{#downloads:EscortDeck.1.6.oxz}} times).

[[Media:EscortDeck.1.5.oxz|EscortDeck.1.5.oxz]] (downloaded {{#downloads:EscortDeck.1.5.oxz}} times).

[[Media:EscortDeck.1.4.oxz|EscortDeck.1.4.oxz]] (downloaded {{#downloads:EscortDeck.1.4.oxz}} times).

[[Media:EscortDeck.1.3.oxz|EscortDeck.1.3.oxz]] (downloaded {{#downloads:EscortDeck.1.3.oxz}} times).

[[Media:EscortDeck.1.2.oxz|EscortDeck.1.2.oxz]] (downloaded {{#downloads:EscortDeck.1.2.oxz}} times).

[[Media:EscortDeck.1.1.oxz|EscortDeck.1.1.oxz]] (downloaded {{#downloads:EscortDeck.1.1.oxz}} times).

[[Media:EscortDeck.1.0.oxz|EscortDeck.1.0.oxz]] (downloaded {{#downloads:EscortDeck.1.0.oxz}} times).

== Changelog ==
2022.12.14. v1.12 Updates escorts' AIs and scripts to avoid closing too fast at landing.
Increases TL for equipments and escort ships.
Adds configuration for launching/calling back when going in/out of red alert.
Adds configuration for base usable derelict probability.
Configuration via Svengali's Library 'Config for AddOns'.
Takes NPC_equipmentDamage OXP's equipment damage into account for usable derelict probability
calculation (reduces base probability of being usable).
Makes Towbar not salvage usable derelicts if Hyperspace Hangar is installed.
Optimizes mass factor (degradation of ship maneuverability by ship's total mass) updates.
Tests for a functional escortdeck in the player ship in event handlers.
Updates shipAtackedOther event handler to handle Laser Reductor presence and be compatible with use
as a ship event handler for the escorts.
Puts a random factor into awarding equipment to usable derelicts, and those equipment could be damaged.
Uses ShipStorageHelper OXP for ship serialization if installed.
Sets event handlers in the escorts' ship scripts to use Laser Reductor.
Fixes bug in scrolling along the pads in the MFD.
Makes Towbar's Tug Drone store usable derelicts in the Hyperspace Hangar.
Performance updates to FCB.
Adds status of escorts' shields to MFD.
Adds menu entry to refuel escort to EscortDeck Station Interface.
Sets current galaxy number and system ID to the shipdata array when storing an escort in Hyperspace Hangar.
2016.07.17. v1.11 Updated for Oolite 1.84 where player can not be the leader of a group.
2016.06.25. v1.9 Fixed long message bug at salvage without Towbar, thanks to Strato1.
Too heavy message is not repeated too often anymore.
Deck is drifting away after player died.
Improved landing code based on the similar part in [[Fighters]] OXP.
2016.03.13. v1.8 Interface menu display the names of ships in deck.
Fixed value in "you paid" message in costly non-main stations.
Aft [[Sniper Gun]] will not move the deck too far anymore, needed by Asp SG and Python SG.
Escort Deck can hold the long Asp SG and Fer-de-Lance SG, Wide Deck can hold Krait SG also.
Carrier top deck can hold Cobra Mark III SG, main deck can hold Krait SG.
Typo fix in shipdata, thanks to phkb.
2015.10.14. v1.7 Interface functions: rename, salvage, put into Hyperspace Hangar and get back.
2015.10.04. v1.6 Escort Deck Interface added into the F4 screen.
Deck positions can be locked to avoid launch of some ships.
Deck cost raised to 2000cr as suggested by Vincentz.
Escorts start with heat shield for sunskimming, requested by QCS.
Chance to find an usable derelict escort is reduced, salvage increased.
MFD show the ship on [[Towbar]] in the last line, maked as T: .
You can release the towed ship by selecting and activating it in MFD.
Show the mass of attached salvage ships on MFD.
Fixed for the change of weaponPositions to array in Oolite 1.83.
Escortship personality is restored from Oolite 1.81.
2015.04.14. v1.5 MFD show max. mass and sizes of empty decks depending on player ship.
Further increased distances on deck before Oolite 1.81.
Fixed maximum mass check of escorts, must below 40% of owner ship's mass.
Hard and Granite escorts counted with original mass (without double density).
Fixed equipment restore on escorts if depends on another equipment.
2015.04.11. v1.4 Collision fixes, needed before Oolite 1.81.
Granite ships on deck do not prevent hyperjump anymore.
From 1.81 slower steering and acceleration in proportion with the mass on deck.
2015.04.06. v1.3 Increased distance around player without Injectors to 5km, thanks to QCS.
Workaround against escort terminated by Witchpoint Beacon.
2015.03.20. v1.2 Refined escort landing sequence to prevent collisions, thanks to QCS.
Added a collisionException between the Witchpoint Beacon and escorts.
Fixed rollback price of unsuccessful escort purchese in Rock Hermits.
2015.01.20. v1.1 No escort launch at injector speeds nor autolaunch at maximum speed.
Fixed escort equipments after load game.
All escorts got a missile pylon to workaround a bug with Carriers' sit into feature.
Escort view positions added.
2015.01.11. v1.0 First release.

== Additions ==
*[[Escort Pack]] adds another 24 possible escorts to choose from

== Quick Facts ==
{{OXPLevel|0}}{{Infobox OXPb| title = EscortDeck
|version = 1.11
|release = 2016.07.17
|features = Personal escort fleet
|license = CC BY-NC-SA 4
|category = Activities OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=17009 BB-Link]
}}

EscortDeck

2022-12-14T17:02:03Z

Dybal: /* Download */

Build up your escort fleet and hold on an external deck attached to your ship.

First you must buy Escort Deck equipment then you will see an attached platform in your aft view.

[[Image:Ed9.png|right]]

=== Ship rules ===

A deck provide 4 landing pads for escort ships with '''max. 130t''' mass, 70m width, 29m height and 135m length: Adder, Asp, Cobra Mark I, Constrictor, Fer-de-Lance, Gecko, Mamba, Moray, Sidewinder and Viper.

If your ship is '''over 130t''' mass like Cobra Mark III then can hold another two small ships like Adders (max. 15m height, 39m width and 65m length) on the sides of the deck.

The mass of your escort must be less than '''40%''' of your ship's mass. For example an Asp (75t) can hold 4 small escorts below 30t: Adder, Gecko or Sidewinder. You should use a ship over 40t mass to be able to use Adders (16t) as escorts. Ships below 30t mass can not get Escort Deck.

Beware of replacing your large ship to a smaller one, all of your escorts will be salvaged which isn't fit into the smaller limits.

=== Wide deck ===

Ships over '''260t''' like Python receive wider deck variant to hold escorts up to 95m width like Krait or [http://aegidian.org/bb/viewtopic.php?f=2&t=16926&hilit=Tiger+Ray&start=45#p229820 Tiger Ray].

[[Image:Ed5.png]]

=== Purchasing escorts ===

You can buy escorts in the ship outfitting (F3) screen. These are not available in the local shipyard but ordered from a remote owner so your time will forwarding a lot if you buy one, but in this way you can buy advanced ships in the low tech worlds also.

Name Cost Energy Recharg Speed Pitch Mass t Eqipment
Adder 80000 85 2 240 2 16 Pulse laser, Injectors, Shield booster
Asp 400000 350 4 400 1 75 Beam Lasers forward and aft, ECM, Injectors, Shield booster
Gecko 100000 250 4 300 1.5 25 Beam Laser, ECM
Sidew. 76000 240 2 370 1.6 26 Beam Laser
Viper 600000 180 4 320 1.8 34 Military Laser, ECM, Injectors, Shield booster and enhancer

* '''Adder Escort''' can utilize the mini landing pads on the sides of your Escort Deck. This special design can hold a Pulse Laser only and no cargo but has Injectors and Shield Boosters.
* '''Asp Escort''' is the fastest and most enduring core escort ship what you can purchase with forward and aft Beam Lasers, ECM, Injectors and Shield Boosters.
* '''Gecko Escort''' is a pirate ship so not available at main stations but strong, small and equipped with a Beam Laser and ECM.
* '''Sidewinder Escort''' is a small and agile ship, useful if your ship isn't large enough to hold [[EscortDeck#Heavy_escorts|heavy escorts]]. Equipped with a Beam Laser but can not use Injectors.
* '''Viper Escort''' is an used GalCop ship, available at main stations only and if your status is clean. This old ship has much lower speed and energy than the modern Interceptors but contain many military equipments.

There are very good pirate escort ships (more if you install [[EscortPack]]) but these are not purchaseable in main stations: you must force to eject the pilot or find in the outfitting list '''in alternative stations'''.

There are rumors about ace '''sniper''' pilots in pirate stations with better ships than an Asp, but these surely costs more than 1MCr if you want to hire them into your escort fleet.

=== Derelicts ===

You can pick up derelict ships: put your target lock on, go nearer than 500m and with less than 100m/s speed difference. If you can not target it (due to the target has jamming device) then you can collide very slowly to trigger the pickup.

If an "usable" message shown in your console when target a derelict ship ([[CombatMFD|Combat MFD]] show it also) then you can use this ship as your escort, else transfer it to a dock on your deck and you will get some money for the '''salvage'''.

If you have [[Towbar]] OXP then you will get reputation also for the delivered salvage.

[[Image:Ed17.png]]

=== Heavy escorts ===

There are heavy escorts around 120t mass, these are multipurpose ships modified for escort jobs which mean removed cargo capacity and some bonuses (please install [[EscortPack]] OXP to get these).

You need a ship with '''325t''' mass to be able to use all escorts up to the maximal 130t, so an Anaconda or special (OXP) Pythons can hold heavy escorts but a Cobra Mark III (215t) or a Boa (182t) can't.

=== Usage ===

You can prime Escort Deck with Shift+N then activate with "n" key to launch or call back your escorts. The mode key "b" select a single escort for launch or callback. There is an auto launch if you enter into red alert and auto callback when changed to green.

You can prevent the launch of any ship if you select it by the mode key then activate once only: the first press will change the status to "LOCKED". The second activate will remove the lock and launch it, but you can call back instantly with a third keypress if you want to stay on the deck without the lock.

There is an auto launch if you enter into red alert and auto callback when changed to green.

There is a Multi-Function Display of Escort Deck, you can turn it on using the ":" and ";" keys.

[[Image:Edmfd.png]]

This show the list of current escorts, a "->" mark before the selected one, name, energy, fuel (if this escort has working Injectors), distance, bearing (^> mean up left) and activity:

ATTACK: Attack a hostile ship (your target first)
DECK: Landed on the deck
FLEE: Flee from a missile or recover some energy (from 40% to 80%)
FOLLOW: Follow your ship at 2km range
GOTO: Go to a hostile ship using Injectors if available until arrive within Beam Laser range (15km)
INJECT: Attack using Injectors until distance is over 10km
LANDING: Landing approach, will not do anything else until landed
LOCKED: Stay on the deck and will not launch with the other ships
SALVAGE: Unusable ship, will be salvaged in the next dock for a few thousand credits
SNIPER: Sniper attack, need a forward laser over 15km range, like Military Laser

You can pick up a new escort even if there is no more free landing pads listed on your MFD if you select a pad and maintain a target lock on the new ship when try to land or an escort is not in your deck. In these cases the old one will be replaced and you will find it bit farther behind your ship.

The released escort will follow you (if it is not derelict) while you stay within the same system and don't take a rest (reload the game), but will not defend you by itself. So you can pick up a derelict ship by replacing one of your escorts, transfer it into a station for payment, then leave the station and relock your old escort to the deck.

If you dock or enter into a wormhole while some of your escorts are not in your deck then those that is within your scanner range will be docked also. Others can be lost, especially if travelled far from you.

If you want to exchange the positions of two escorts on your deck then do these in order:
1. Select an escort by mode key (b) if Escort Deck is primed with Shift+N and all escorts landed.
2. Launch it with the activate key (n) and wait a few seconds for it to go out of landing distance.
3. Press activate (n) again to order it back to landing and turn your ship to keep it in your screen.
4. Press mode (b) until you select the second escort to flag the wanted landing position.
5. Put your target lock to the launched ship: press "r" and aim well with your crosshairs.
6. Wait for landing when the exchange will be done.

The MFD can show the ship on [[Towbar]] in the last line, maked as T: . You can release the towed ship by selecting and activating it in this MFD. If no ship on your Towbar then show the maximal mass which your ship can tow (1.6 times of the mass of your ship).

Your escorts will be refuelled when you buy fuel for your ship.

Cost: 2000.0 Cr.
Techlevel: 1

== Escort Deck XL ==

If your ship is over '''400t''' like an Anaconda then you can buy XL deck instead of the common deck can hold '''8 escorts''' behind you, but the mass limit is lower: max. '''60t''', so you can't use Asp and heavy escort ships.

If you have Towbar then you can't pick up any ship there due to the long XL deck occupy the same space behind you. The simple escort deck is shorter and Towbar compatible so if you plan to salvage larger ships than small escorts then you should choose the normal deck.

Warning: your ship can be "uber" if you use 8 escorts, so if you want limit yoursef then stick with the smaller deck and avoid the XL variant.

[[Carriers]] can hold '''10 escorts''' on the internal XL deck (the "neck") and the mass limit is 130t as in the normal deck. Moreover the '''first two pads''' (on the top) can hold '''wider and heavier''' ships up to '''378t''' (40% of Carriers' mass) and 130x35x95m including Cobra Mark III, Krait and other large ships also. This is even more "uber" but intentionally: a Carrier should be able to hold stronger fleet than others.

Cost: 2000.0 Cr.
Techlevel: 1

== Interface ==

In F4 screen you can view, '''rename''' and '''salvage''' your current escorts. Moreover if [[Hyperspace Hangar]] is installed then you can '''buy esorts from the main shipyard''' (F3F3) using the following steps:

1. Buy a small ship from a shipyard which fit into your deck and save your main ship into the Hyperspace Hangar.
2. Equip it for combat as you wish, just avoid player-only tools like Railgun.
3. Save the escort into the hangar by switching into your main ship.
4. Go to the Escort Deck interface, select an empty deck and get the escort from the hangar.

The hangar is usable as a temporary storage to '''rearrange''' your escorts as well as '''fix damaged equipments''' or '''buy new ones''', just store your main ship into the hangar:

1. Select a ship in the EscortDeck Interface.
2. Put into Hyperspace Hangar.
3. Go into the interface of Hyperspace Hangar and switch into the stored escort.
4. Equip or fix it.
5. Switch back into your main ship in the hangar interface.
6. Go to the EscortDeck interface, select an empty deck and get your escort from the hangar.

If you acquired an OXP escort ship which is not designed for player then you can not switch into.

[[Image:Ed18.png|1000px]]

You can upgrade the whole escort if you buy another ship in shipyard (F3F3) while you are switched into an escort. The old ship will be counted into the cost of the new one, regardless of you found (or just forced to eject) in the deep space.

The trade-in value (75% of ship price) is displayed in the interface (see the top left corner in the screenshot above) due to this reason. But you are not able to sell an escort and get this big money directly (to keep up some balance).

== Ship mass table ==

Adder 16
Moray 51
Cobra Mk I 52
Fer-de-Lance 53
Asp 75
Boa 182
Cobra Mk III 215
Boa2 216
Python 267
Anaconda 438

NPC:
Gecko 25
Sidewinder 26
Constrictor 28
Viper 34
Mamba 36
Krait 94

== Escort Deck variants ==

You will get one of the following variants depending on the mass of your ship.

* Below 30t: You can not use any decks.

* 30t-130t: '''Small deck''' without side pads.
[[Image:Ed14.png]]

* 130t-260t: '''Normal deck''' with side pads for two additional mini escorts (Adder).
[[Image:Ed8.png]]

* 260t-: '''Wide deck''' which can hold ships up to 95m width (Krait).
[[Image:Ed2.png]]

* 400t-: You can choose either the wider deck or '''XL deck'''.
[[Image:Ed11.png]]

* [[Carriers]] can hold the most powerful escort fleet, using the big hull as a deck.

[[Image:Carriers4.png]]

For more information see the [http://aegidian.org/bb/viewtopic.php?f=4&t=17009 regarding discussuion].

== Screenshots ==

Flying peacefully:

[[Image:Ed10.png]]

Escorts released to counterattack a bad guy:

[[Image:Ed16.png|1000px]]

== License ==

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

The 3D models of decks are derived from Leviathan Platform in Aquatics OXP, thanks to Thargoid and P.A. Groove.

Escort locked sound is equal with Towbar locked which is based on bgs-m_fx_shipyard1.ogg in BGS OXP.

== Download ==

[[Media:EscortDeck-1.12.oxz|EscortDeck-1.12.oxz]].

Recommended: [[EscortPack]], [[Carriers]], [[Towbar]], [[Library OXP]].

Old versions:

[[Media:EscortDeck_1.11.oxz|EscortDeck_1.11.oxz]] (downloaded {{#downloads:EscortDeck_1.11.oxz}} times)

[[Media:EscortDeck.1.9.oxz|EscortDeck.1.9.oxz]] (downloaded {{#downloads:EscortDeck.1.9.oxz}} times).

[[Media:EscortDeck.1.8.oxz|EscortDeck.1.8.oxz]] (downloaded {{#downloads:EscortDeck.1.8.oxz}} times).

[[Media:EscortDeck.1.7.oxz|EscortDeck.1.7.oxz]] (downloaded {{#downloads:EscortDeck.1.7.oxz}} times).

[[Media:EscortDeck.1.6.oxz|EscortDeck.1.6.oxz]] (downloaded {{#downloads:EscortDeck.1.6.oxz}} times).

[[Media:EscortDeck.1.5.oxz|EscortDeck.1.5.oxz]] (downloaded {{#downloads:EscortDeck.1.5.oxz}} times).

[[Media:EscortDeck.1.4.oxz|EscortDeck.1.4.oxz]] (downloaded {{#downloads:EscortDeck.1.4.oxz}} times).

[[Media:EscortDeck.1.3.oxz|EscortDeck.1.3.oxz]] (downloaded {{#downloads:EscortDeck.1.3.oxz}} times).

[[Media:EscortDeck.1.2.oxz|EscortDeck.1.2.oxz]] (downloaded {{#downloads:EscortDeck.1.2.oxz}} times).

[[Media:EscortDeck.1.1.oxz|EscortDeck.1.1.oxz]] (downloaded {{#downloads:EscortDeck.1.1.oxz}} times).

[[Media:EscortDeck.1.0.oxz|EscortDeck.1.0.oxz]] (downloaded {{#downloads:EscortDeck.1.0.oxz}} times).

== Changelog ==
2016.07.17. v1.11 Updated for Oolite 1.84 where player can not be the leader of a group.
2016.06.25. v1.9 Fixed long message bug at salvage without Towbar, thanks to Strato1.
Too heavy message is not repeated too often anymore.
Deck is drifting away after player died.
Improved landing code based on the similar part in [[Fighters]] OXP.
2016.03.13. v1.8 Interface menu display the names of ships in deck.
Fixed value in "you paid" message in costly non-main stations.
Aft [[Sniper Gun]] will not move the deck too far anymore, needed by Asp SG and Python SG.
Escort Deck can hold the long Asp SG and Fer-de-Lance SG, Wide Deck can hold Krait SG also.
Carrier top deck can hold Cobra Mark III SG, main deck can hold Krait SG.
Typo fix in shipdata, thanks to phkb.
2015.10.14. v1.7 Interface functions: rename, salvage, put into Hyperspace Hangar and get back.
2015.10.04. v1.6 Escort Deck Interface added into the F4 screen.
Deck positions can be locked to avoid launch of some ships.
Deck cost raised to 2000cr as suggested by Vincentz.
Escorts start with heat shield for sunskimming, requested by QCS.
Chance to find an usable derelict escort is reduced, salvage increased.
MFD show the ship on [[Towbar]] in the last line, maked as T: .
You can release the towed ship by selecting and activating it in MFD.
Show the mass of attached salvage ships on MFD.
Fixed for the change of weaponPositions to array in Oolite 1.83.
Escortship personality is restored from Oolite 1.81.
2015.04.14. v1.5 MFD show max. mass and sizes of empty decks depending on player ship.
Further increased distances on deck before Oolite 1.81.
Fixed maximum mass check of escorts, must below 40% of owner ship's mass.
Hard and Granite escorts counted with original mass (without double density).
Fixed equipment restore on escorts if depends on another equipment.
2015.04.11. v1.4 Collision fixes, needed before Oolite 1.81.
Granite ships on deck do not prevent hyperjump anymore.
From 1.81 slower steering and acceleration in proportion with the mass on deck.
2015.04.06. v1.3 Increased distance around player without Injectors to 5km, thanks to QCS.
Workaround against escort terminated by Witchpoint Beacon.
2015.03.20. v1.2 Refined escort landing sequence to prevent collisions, thanks to QCS.
Added a collisionException between the Witchpoint Beacon and escorts.
Fixed rollback price of unsuccessful escort purchese in Rock Hermits.
2015.01.20. v1.1 No escort launch at injector speeds nor autolaunch at maximum speed.
Fixed escort equipments after load game.
All escorts got a missile pylon to workaround a bug with Carriers' sit into feature.
Escort view positions added.
2015.01.11. v1.0 First release.

== Additions ==
*[[Escort Pack]] adds another 24 possible escorts to choose from

== Quick Facts ==
{{OXPLevel|0}}{{Infobox OXPb| title = EscortDeck
|version = 1.11
|release = 2016.07.17
|features = Personal escort fleet
|license = CC BY-NC-SA 4
|category = Activities OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=17009 BB-Link]
}}

File:EscortDeck-1.12.oxz

2022-12-14T16:56:58Z

Dybal: Version 1.12

== Summary ==
Version 1.12

Hyperspace Hangar

2022-11-23T18:21:05Z

Dybal: /* Features */

[[Category:Mechanics OXPs]][[Category:OXPConfig-compatible OXPs]]
[[Image:OXPConfig_logo.png|150px|right]]
==Overview==
Allows storage of ships in the Hyperspace Hangar service for a fee, accessible from any station. Ships are only stored if bought with cash, not credit.
It takes 30 minutes to store a ship by default. Fee is defaulted to 25000 cr. Options can be activated through OXPConfig.

==Features==
* Stores ships.
* Allows switching of ships from the Hyperspace Hangar menu.
* Allows you to sell your current ship, and then switch ships.
* Allows you to sell stored ships.
* You must transfer your ship to your current station to switch. This is done by either selecting a system on the chart and using the send option, or by using the order option from your current station and waiting X hours, where X is the time to jump to your station. Fee for either is the distance of the route * 90. The ship is then enters a in-transit state until its arrival at the destination system.
* If your ship is in another galaxy, you must order it sent to your current station. Price is the number of galaxies distant * 1000 Cr. Time is the number of galaxies distant * 72 hours.
* If switching in a station with an equivalent TL of 6 or lower, there is a 7/8 chance of damaging your ship.
* A rudimentary mission, which begins in G3.
* If EscortDeck OXP is installed, it can use Hyperspace Hangar to store escort ships and usable derelicts. If those stored ship can be used as player ship, the player can switch into them and take them for a spin!

==Image==
[[Image:HyperspaceHangar.png|1024px]]

==Requirements==
* This [[OXP]] needs Oolite v1.79.
* Ship Storage Helper by Capt. Murphy.

== License ==
This oxp is licensed under the [https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode CC-BY-NC-SA 3.0]

Hangar background image [http://kheng.deviantart.com/art/Launch-Bay-WIP5-449525179 launch_bay_wip5_by_kheng-d7fmvuj.png] is made by Kheng Teoh who [http://aegidian.org/bb/viewtopic.php?f=7&t=17492#p237635 allowed the usage].

==Download==
[[Media:HyperspaceHangar-1.17.0.oxz|Hyperspace_Hangar-1.17.0.oxz]]

Previous versions: 
Version [[Media:Hyperspace_Hangar.oxz|Hyperspace_Hangar.oxz]] 1.16.0 (downloaded {{#downloads:Hyperspace_Hangar.oxz}} times). 
[[Media:Hyperspace_Hangar-1.14.9.oxz|Hyperspace_Hangar-1.14.9.oxz]] 3.39 Mb - Downloaded {{#downloads:Hyperspace_Hangar-1.14.9.oxz}} time(s).

== Changelog ==

2022.11.23, v1.17.0

* Preserves libconfig option to savefile.
* Portable equipment is not passed on to bought ship if old ship was stored.
* Shows Station Interface even if no ship is stored in Hyperspace Hangar.
* When selling ships through HH the price is 15% of trade-in price.
* Damage might occur when switching into ships in station of TL<7.
* Nest try/catch in the sell stored ship option so if an error occur when replacing ship we can revert the operation.
* Check and reports insufficient funds for a ship transfer.
* Creates in-transit state for stored ships: ordering ships transferred to current system do not advance the game clock to the ship's arrival moment anymore.
* Fixes sell option station interface's screens flux.
* Selling a stored ship doesn't advance game clock.
* Expands "ships in transit" to sending ships to other systems.
* Shows ships in transit in the Hyperspace Hangar station interface.
* Transit time information in hours is displayed with single decimal digit

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.84"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsConfigurable=true}}
{|class="floatright" style="alignment:right;margin: 0 auto;"
|[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
|{{OXPConfig-small}}
|}
{{Infobox OXPb| title = Hyperspace Hangar
|version = 1.17.0
|release = 2022-11-23
|license = CC-BY-NC-SA 3.0
|features = Storage of ships and related utilities.
|category = Mechanics OXPs
|author = [[User:Ramen|Ramen]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=17437 Oolite BB]
}}

Hyperspace Hangar

2022-11-23T14:56:17Z

Dybal: /* Features */

[[Category:Mechanics OXPs]][[Category:OXPConfig-compatible OXPs]]
[[Image:OXPConfig_logo.png|150px|right]]
==Overview==
Allows storage of ships in the Hyperspace Hangar service for a fee, accessible from any station. Ships are only stored if bought with cash, not credit.
It takes 30 minutes to store a ship by default. Fee is defaulted to 25000 cr. Options can be activated through OXPConfig.

==Features==
* Stores ships.
* Allows switching of ships from the Hyperspace Hangar menu.
* Allows you to sell your current ship, and then switch ships.
* Allows you to sell stored ships.
* You must transfer your ship to your current station to switch. This is done by either selecting a system on the chart and using the send option, or by using the order option from your current station and waiting X hours, where X is the time to jump to your station. Fee for either is the distance of the route * 90. The ship is then enters a in-transit state until its arrival at the destination system.
* If your ship is in another galaxy, you must order it sent to your current station. Price is the number of galaxies distant * 1000 Cr. Time is the number of galaxies distant * 72 hours.
* If switching in a station with an equivalent TL of 6 or lower, there is a 7/8 chance of damaging your ship.
* A rudimentary mission, which begins in G3.
* If EscortDeck OXP is installed, it can use Hyperspace Hangar to store escort ship and usable derelicts. If those stored ship can be used as player ship, the player can switch into them and take them for a spin!

==Image==
[[Image:HyperspaceHangar.png|1024px]]

==Requirements==
* This [[OXP]] needs Oolite v1.79.
* Ship Storage Helper by Capt. Murphy.

== License ==
This oxp is licensed under the [https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode CC-BY-NC-SA 3.0]

Hangar background image [http://kheng.deviantart.com/art/Launch-Bay-WIP5-449525179 launch_bay_wip5_by_kheng-d7fmvuj.png] is made by Kheng Teoh who [http://aegidian.org/bb/viewtopic.php?f=7&t=17492#p237635 allowed the usage].

==Download==
[[Media:HyperspaceHangar-1.17.0.oxz|Hyperspace_Hangar-1.17.0.oxz]]

Previous versions: 
Version [[Media:Hyperspace_Hangar.oxz|Hyperspace_Hangar.oxz]] 1.16.0 (downloaded {{#downloads:Hyperspace_Hangar.oxz}} times). 
[[Media:Hyperspace_Hangar-1.14.9.oxz|Hyperspace_Hangar-1.14.9.oxz]] 3.39 Mb - Downloaded {{#downloads:Hyperspace_Hangar-1.14.9.oxz}} time(s).

== Changelog ==

2022.11.23, v1.17.0

* Preserves libconfig option to savefile.
* Portable equipment is not passed on to bought ship if old ship was stored.
* Shows Station Interface even if no ship is stored in Hyperspace Hangar.
* When selling ships through HH the price is 15% of trade-in price.
* Damage might occur when switching into ships in station of TL<7.
* Nest try/catch in the sell stored ship option so if an error occur when replacing ship we can revert the operation.
* Check and reports insufficient funds for a ship transfer.
* Creates in-transit state for stored ships: ordering ships transferred to current system do not advance the game clock to the ship's arrival moment anymore.
* Fixes sell option station interface's screens flux.
* Selling a stored ship doesn't advance game clock.
* Expands "ships in transit" to sending ships to other systems.
* Shows ships in transit in the Hyperspace Hangar station interface.
* Transit time information in hours is displayed with single decimal digit

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.84"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsConfigurable=true}}
{|class="floatright" style="alignment:right;margin: 0 auto;"
|[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
|{{OXPConfig-small}}
|}
{{Infobox OXPb| title = Hyperspace Hangar
|version = 1.17.0
|release = 2022-11-23
|license = CC-BY-NC-SA 3.0
|features = Storage of ships and related utilities.
|category = Mechanics OXPs
|author = [[User:Ramen|Ramen]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=17437 Oolite BB]
}}

Hyperspace Hangar

2022-11-23T14:51:48Z

Dybal:

[[Category:Mechanics OXPs]][[Category:OXPConfig-compatible OXPs]]
[[Image:OXPConfig_logo.png|150px|right]]
==Overview==
Allows storage of ships in the Hyperspace Hangar service for a fee, accessible from any station. Ships are only stored if bought with cash, not credit.
It takes 30 minutes to store a ship by default. Fee is defaulted to 25000 cr. Options can be activated through OXPConfig.

==Features==
* Stores ships.
* Allows switching of ships from the Hyperspace Hangar menu.
* Allows you to sell your current ship, and then switch ships.
* Allows you to sell stored ships.
* You must transfer your ship to your current station to switch. This is done by either selecting a system on the chart and using the send option, or by using the order option from your current station and waiting X hours, where X is the time to jump to your station. Fee for either is the distance of the route * 90.
* If your ship is in another galaxy, you must order it sent to your current station. Price is the number of galaxies distant * 1000 Cr. Time is the number of galaxies distant * 72 hours.
* If switching in a station with an equivalent TL of 6 or lower, there is a 7/8 chance of damaging your ship.
* A rudimentary mission, which begins in G3.
==Image==
[[Image:HyperspaceHangar.png|1024px]]

==Requirements==
* This [[OXP]] needs Oolite v1.79.
* Ship Storage Helper by Capt. Murphy.

== License ==
This oxp is licensed under the [https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode CC-BY-NC-SA 3.0]

Hangar background image [http://kheng.deviantart.com/art/Launch-Bay-WIP5-449525179 launch_bay_wip5_by_kheng-d7fmvuj.png] is made by Kheng Teoh who [http://aegidian.org/bb/viewtopic.php?f=7&t=17492#p237635 allowed the usage].

==Download==
[[Media:HyperspaceHangar-1.17.0.oxz|Hyperspace_Hangar-1.17.0.oxz]]

Previous versions: 
Version [[Media:Hyperspace_Hangar.oxz|Hyperspace_Hangar.oxz]] 1.16.0 (downloaded {{#downloads:Hyperspace_Hangar.oxz}} times). 
[[Media:Hyperspace_Hangar-1.14.9.oxz|Hyperspace_Hangar-1.14.9.oxz]] 3.39 Mb - Downloaded {{#downloads:Hyperspace_Hangar-1.14.9.oxz}} time(s).

== Changelog ==

2022.11.23, v1.17.0

* Preserves libconfig option to savefile.
* Portable equipment is not passed on to bought ship if old ship was stored.
* Shows Station Interface even if no ship is stored in Hyperspace Hangar.
* When selling ships through HH the price is 15% of trade-in price.
* Damage might occur when switching into ships in station of TL<7.
* Nest try/catch in the sell stored ship option so if an error occur when replacing ship we can revert the operation.
* Check and reports insufficient funds for a ship transfer.
* Creates in-transit state for stored ships: ordering ships transferred to current system do not advance the game clock to the ship's arrival moment anymore.
* Fixes sell option station interface's screens flux.
* Selling a stored ship doesn't advance game clock.
* Expands "ships in transit" to sending ships to other systems.
* Shows ships in transit in the Hyperspace Hangar station interface.
* Transit time information in hours is displayed with single decimal digit

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.84"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsConfigurable=true}}
{|class="floatright" style="alignment:right;margin: 0 auto;"
|[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
|{{OXPConfig-small}}
|}
{{Infobox OXPb| title = Hyperspace Hangar
|version = 1.17.0
|release = 2022-11-23
|license = CC-BY-NC-SA 3.0
|features = Storage of ships and related utilities.
|category = Mechanics OXPs
|author = [[User:Ramen|Ramen]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=17437 Oolite BB]
}}

Hyperspace Hangar

2022-11-23T14:45:40Z

Dybal: /* Quick Facts */

Hyperspace Hangar

2022-11-23T14:45:11Z

Dybal: /* Download */

File:HyperspaceHangar-1.17.0.oxz

2022-11-23T14:39:41Z

Dybal: Version 1.17.0

== Summary ==
Version 1.17.0

N-Shields

2022-10-26T23:12:13Z

Dybal: /* Downloads */

== Description ==
Gives NPCs highly customizable shields, with the default setting (as in [[CustomShields]]) being a 'fair' emulation of the player's shields.

Features:

- Fair shield recharge code (CustomShields didn't charge shields until energy banks were full)

- Acts as a hub for handling damage to NPCs, calling damage handlers from other OXPs after the shields are depleted and the damage reach the ship's hull, providing better compatibility for other OXPs with shipTakingDamage overrides

- Thargoids get dorsal/ventral shields. Support for other very non-standard shield configurations was attempted but removed in version 0.7 to simplify the code.

- More customisable colours. The default multicolour set goes from green down to red for standard shields, extending to blue/purple with upgrades.

- New visual effects based on explosions.plist for shields and unshielded hits.

- Awards Shield Cycler for a percentage of the ships that don't have them, configures Shield Booster and Military Shield Booster for NPCs that have them, apply shield recharge enhancements from Energy Grid (civillian and naval) for ships that have them.

== Settings in N-Shields.js scripts ==

There are some settings that can be modified in N-Shields script no change tnhe OXP behaviour:

* <code>this._NPC_shields = true;</code>
:Switch simulated shields on or off. If false, visual effects will be drawn based on energy level.

* <code>this._Thargoid_shields = true;</code>
:As above, but applies to Thargoids.

* <code>this._Thargoid_energyReduction = true;</code>
:Reduce Thargoids' energy banks to balance their new shields.

* <code>this._NPC_flasherColours = 1;</code>
:Pre-defined flasher list to use for standard NPC shields.
:Options:
::0: "_multicolour1", simple and bright
::1: "_multicolour2", slightly different colours, reduced alpha when low
::2: "_multicolour3", reverse colour order (red high, blue low)
::3: "_green", the Thargoid default (but can be used for other NPCs too)
::4: "_blue", various shades of blue

* <code>this._Thargoid_flasherColours = 3;</code>
:Colour for Thargoid shields, options as above.

* <code>this._flasherScale = 1;</code>
:Scale factor for flasher effects.

== Notes for OXP developers ==

=== scriptInfo properties ===

N-Shields looks for the following ship's scriptInfo properties:
* <code>npc_shields = "no";</code>
: N-Shields ignores the ship and doesn't do anything.

* <code>NShields_flasherKeys = ("myRed1", "myRed2", "myRed3", "myRed3", "myRed4");</code>
: A list of partial effectdata.plist keys, which will be prefixed with "N-Shields_flasher_" to obtain the full key for each flasher or other visualEffect.
: Ordered from lowest shield level to highest in 32-point increments.

* <code>NShields_flasherPreset = 3;</code>
: Number indicating one of the pre-defined flasher lists.
: See above for available options.

* <code>max_shield_aft = 128;</code>
* <code>max_shield_forward = 128;</code>
* <code>shield_recharge_aft = 2.0;</code>
* <code>shield_recharge_forward = 2.0;</code>
: Customise shield levels and recharge rates for this ship.
: The example above shows the standard default shields.
: Note that these can apply to player ships as well as NPCs.
: For Thargoid vessels, use 'upper' and 'lower' instead of 'forward' and 'aft'.

* <code>NShields_energyReduction = 128;</code>
: Specify an energy-bank reduction which will be applied when shields are set up.
: This is intended for two purposes:
::1) For mission ships, to prevent already-difficult opponents becoming impossible
::2) For ships which are 'supposed' to have strong shields, but 'fake it' with bigger energy banks when N-Shields is not installed.

* <code>NShields_exploders = ("NShields-explode-ring-red")</code>
: Custom exploder effect list. The example would make your ship spawn red(ish) ring explosions when its shields are hit.

* <code>NShields_protect_subentities = "no";</code>
: If defined as shown, shields will not protect frangible subentities on this ship.
: The subentities may be left exposed, or given their own shield configurations like any other ship.

The script_info keys "NShields_config" and "NShields_colours" are no longer supported.

=== Compatibility with other shipTakingDamage handler overrides ===

N-Shields provides an array onto which other OXPs can push their NPC ''shipTakingDamage'' handlers instead of actually overriding the handler in the ship script. Functions in this array will imitate the player's world-script ''shipTakingDamage'' handler; that is, they are called for every hit but with the 'amount' parameter only conveying damage which actually penetrated the shields (0 if the hit was entirely absorbed by shields). This approach ensures your handler will be called in the same manner regardless of OXP loading order and avoids any need for your OXP to detect which shield was hit and whether it's still up.

There are two ways to use this feature:

:1) In your script's ''startUp'' handler:

if (worldScripts.NShields && worldScripts.NShields.$shipHasShields(ship)) {
worldScripts.NShields._damageHandlers.push(my_shipTakingDamage_override)
} else {
//apply your handler override directly here
}

::Replace ''my_shipTakingDamage_override'' with your handler name.
::This approach applies your handler to all ships which have simulated shields, but not to those which don't. If you need to choose which ships get the handler yourself, use the other option:

:2) In your script's ''shipSpawned'' handler, once you have decided that a ship should get your ''shipTakingDamage'' override:

if (worldScripts.NShields && worldScripts.NShields.$shipHasShields(ship)) {
if (!ship.script._NShields_damageHandlers)
//set up the array if N-Shields hasn't run its shipSpawned handler yet
ship.script._NShields_damageHandlers = [];
ship.script._NShields_damageHandlers.push(my_shipTakingDamage_override)
} else {
//apply your handler override directly here
}

::Replace ''my_shipTakingDamage_override'' with your handler name.

=== function to configure NPC ship ===

N-Shields makes available to other OXPs a function to configure the NPC's shields after awarding of any defense-related equipment to it:

worldScripts.NShields.$configureShip(ship)

This idempotent (i.e. can be called several times without adverse effects) function will configure the ship's shields taking into account any script_info properties defined and the equipments isntalled in the ship, like Shield Booster, Military Shield Enhancement, Energy Grid, Shield Cycler, etc.

== Downloads ==
latest version available on the Expansion Manager and here: [[Media:N-Shields-1.0.2.oxz|N-Shields v1.0.2]]

[[Media:N-Shields-1.0.1.oxz|N-Shields v1.0.1]]

[http://wiki.alioth.net/img_auth.php/b/b0/N-Shields_0.7.oxz N-Shields 0.7] {{#downloads:N-Shields_0.7.oxz}} downloads

[http://wiki.alioth.net/img_auth.php/2/2d/N-Shields.oxz N-Shields 0.6.4] downloaded {{#downloads:N-Shields.oxz}} times

== Version History ==

1.0.2
* Fixes bug: once fully recharged, NPC and Thargoid shields didn't recharge anymore.

1.0.1 (by Dybal)
* Doesn't add shields to scoopable "ships" (that includes all variations of escape capsules, even if their primary role happens to be different from escape-capsule).
* Fixes bugs that broke idempotency of $configureShip (leading to infinite loops at damage handling if $configureShip was called twice on the same ship).
* Fixes bug that led to "invulnerable ship" if the ship's script had its own shipTakingDamage event handler.

1.0 (by Dybal)
* Drops support for Shield Cycler (and Shield Cycler Next) 1.x for NPCs.
* Creates idempotent function for OXPs to call to configure a NPC's shields.
* Encapsulates modifications of ship's energy to verify for NaN before assigning a value into ship.energy (to prevent "invulnerable ship" bug).
* Adds delay to shipSpawned before setting up the ship to allow other OXPs' shipSpawned to award equipments.
* Configures shield recharge rate with Energy Grid (civilian and naval) upgrades if the NPC has them installed.
* Configures both Military Shield Enhancement and Shield Enhancer for NPCs.
* Doesn't award Shield Cycler to NPCs that have Shield Equalizer.
* Fixes bugs in handling of damage to subentities.
* Standardizes script object properties names: functions references start with '$' (except event handlers), everything else starts with '_';

0.7.1
* Fixed missing "use strict" in N-Shields.js.
* Removed Ship Configuration compatibility script entry from world-scripts.plist (the actual script was removed in 0.7.0).
* Reduced Thargoids' max shields (and compensatory energy reduction) slightly.

0.7
* Removed support for unusual/configurable shield types, except dorsal/ventral which now applies to Thargoids only, in order to simplify the scripts.
* Changed flashers from Ship entities to VisualEffects.
* Pre-defined flasher colour options: 3x Multicolour, Green, Blue.
* Hemisphere glow effects removed.
* New script_info keys NShields_flasherPreset, NShields_flasherKeys, max_shield_forward etc. to replace the now-unsupported NShields_colours, NShields_config.
* Config interface now works correctly (requires Oolite 1.83 or higher and Library OXP).
* Improved efficiency of hit-location code.
* Tentative support for Shield Cyclers on NPCs.

0.6.4
* Fixed bug in $locateHit cloaked-attacker handling (missing a ".position" or two).

0.6.3
* Fixed some bugs in NPC Equipment Damage compatibility code

0.6.2
* Fixed bug in manifest (missing "}").

0.6.1
* Added correctly functioning shipconfig version check and fixed small variable non-declaration in $drawSparks

0.6
* Added user-friendly configuration options via Library OXP.
* Hemisphere glow effects now work, although they still look awful.
* Added compatibility with NPC Equipment Damage OXP.

0.5.4
* Removed non-functioning version check; tested & corrected quaternion multiplication.

0.5.3
* Added version check in NShields-shipconfig-compatibility.js as requested by phkb

0.5.2
* Attempt to fix buggy aft shield effect orientation by using quaternion multiplication. Untested due to oolite-trunk launching error.

0.5.1
* Fixed bug in subentity shielding code which didn't check whether a shipTakingDamage handler had been stored before trying to call it
* Added hemisphere glow effects (disabled by default because very under-debugged & not really working yet)

0.5
* Added explosion-based shield effects.

0.4
* Improved recharge code for fore/aft shields works more like the core player version.
* Correct handling of heat damage (hopefully?).
* $locateHit now attempts to identify a cloaked attacker if the parameter passed is null.
* Added dorsal/ventral shield configuration option and changed Thargoid default to use this.
* Fixed bug in $configureShieldsFromArray which caused Thargoid shield config failure.

0.3
* New features: Player shield effects, NPC shields protect subentities, spark effects for unshielded hits.
* Support for Ship Configuration OXP's shield upgrades/downgrades.
* Fixed bug in recharge code which resulted in excessive energy drain.
* Not released.

0.2
* Extensive re-write implementing some configuration options.
* 'single' and 'fore/aft' shield types supported.
* Damage handler array added for compatibility with other OXPs.
* Not released.

0.1
* Very basic shield simulation. Not released.

== Quick Facts ==

{{OXPLevel|4}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Medium"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
{{Infobox OXPb| title N-Shields
|version = 1.0.2
|release = 2020-12-02
|license = CC-BY-SA 3.0
|features = Provides shields for NPCs.
|category = Mechanics OXPs
|author = [[User:Ngalo|NGalo]]
|feedback = [http://www.aegidian.org/bb/viewtopic.php?f=4&t=18127 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

== Links ==
*[[User:Ngalo|Commander Ngalo's other OXP's]]

*[[CustomShields]] - flashy 2012 equivalent (features visible damage effects)
*[[NPC-shields OXP]] - Commander McLane's original OXP in this area (2011-2)

*[[Cheating]] - see discussion on anti-cheating...

{{equipment-OXP}}

N-Shields

2022-10-26T23:11:31Z

Dybal: /* Version History */

== Description ==
Gives NPCs highly customizable shields, with the default setting (as in [[CustomShields]]) being a 'fair' emulation of the player's shields.

Features:

- Fair shield recharge code (CustomShields didn't charge shields until energy banks were full)

- Acts as a hub for handling damage to NPCs, calling damage handlers from other OXPs after the shields are depleted and the damage reach the ship's hull, providing better compatibility for other OXPs with shipTakingDamage overrides

- Thargoids get dorsal/ventral shields. Support for other very non-standard shield configurations was attempted but removed in version 0.7 to simplify the code.

- More customisable colours. The default multicolour set goes from green down to red for standard shields, extending to blue/purple with upgrades.

- New visual effects based on explosions.plist for shields and unshielded hits.

- Awards Shield Cycler for a percentage of the ships that don't have them, configures Shield Booster and Military Shield Booster for NPCs that have them, apply shield recharge enhancements from Energy Grid (civillian and naval) for ships that have them.

== Settings in N-Shields.js scripts ==

There are some settings that can be modified in N-Shields script no change tnhe OXP behaviour:

* <code>this._NPC_shields = true;</code>
:Switch simulated shields on or off. If false, visual effects will be drawn based on energy level.

* <code>this._Thargoid_shields = true;</code>
:As above, but applies to Thargoids.

* <code>this._Thargoid_energyReduction = true;</code>
:Reduce Thargoids' energy banks to balance their new shields.

* <code>this._NPC_flasherColours = 1;</code>
:Pre-defined flasher list to use for standard NPC shields.
:Options:
::0: "_multicolour1", simple and bright
::1: "_multicolour2", slightly different colours, reduced alpha when low
::2: "_multicolour3", reverse colour order (red high, blue low)
::3: "_green", the Thargoid default (but can be used for other NPCs too)
::4: "_blue", various shades of blue

* <code>this._Thargoid_flasherColours = 3;</code>
:Colour for Thargoid shields, options as above.

* <code>this._flasherScale = 1;</code>
:Scale factor for flasher effects.

== Notes for OXP developers ==

=== scriptInfo properties ===

N-Shields looks for the following ship's scriptInfo properties:
* <code>npc_shields = "no";</code>
: N-Shields ignores the ship and doesn't do anything.

* <code>NShields_flasherKeys = ("myRed1", "myRed2", "myRed3", "myRed3", "myRed4");</code>
: A list of partial effectdata.plist keys, which will be prefixed with "N-Shields_flasher_" to obtain the full key for each flasher or other visualEffect.
: Ordered from lowest shield level to highest in 32-point increments.

* <code>NShields_flasherPreset = 3;</code>
: Number indicating one of the pre-defined flasher lists.
: See above for available options.

* <code>max_shield_aft = 128;</code>
* <code>max_shield_forward = 128;</code>
* <code>shield_recharge_aft = 2.0;</code>
* <code>shield_recharge_forward = 2.0;</code>
: Customise shield levels and recharge rates for this ship.
: The example above shows the standard default shields.
: Note that these can apply to player ships as well as NPCs.
: For Thargoid vessels, use 'upper' and 'lower' instead of 'forward' and 'aft'.

* <code>NShields_energyReduction = 128;</code>
: Specify an energy-bank reduction which will be applied when shields are set up.
: This is intended for two purposes:
::1) For mission ships, to prevent already-difficult opponents becoming impossible
::2) For ships which are 'supposed' to have strong shields, but 'fake it' with bigger energy banks when N-Shields is not installed.

* <code>NShields_exploders = ("NShields-explode-ring-red")</code>
: Custom exploder effect list. The example would make your ship spawn red(ish) ring explosions when its shields are hit.

* <code>NShields_protect_subentities = "no";</code>
: If defined as shown, shields will not protect frangible subentities on this ship.
: The subentities may be left exposed, or given their own shield configurations like any other ship.

The script_info keys "NShields_config" and "NShields_colours" are no longer supported.

=== Compatibility with other shipTakingDamage handler overrides ===

N-Shields provides an array onto which other OXPs can push their NPC ''shipTakingDamage'' handlers instead of actually overriding the handler in the ship script. Functions in this array will imitate the player's world-script ''shipTakingDamage'' handler; that is, they are called for every hit but with the 'amount' parameter only conveying damage which actually penetrated the shields (0 if the hit was entirely absorbed by shields). This approach ensures your handler will be called in the same manner regardless of OXP loading order and avoids any need for your OXP to detect which shield was hit and whether it's still up.

There are two ways to use this feature:

:1) In your script's ''startUp'' handler:

if (worldScripts.NShields && worldScripts.NShields.$shipHasShields(ship)) {
worldScripts.NShields._damageHandlers.push(my_shipTakingDamage_override)
} else {
//apply your handler override directly here
}

::Replace ''my_shipTakingDamage_override'' with your handler name.
::This approach applies your handler to all ships which have simulated shields, but not to those which don't. If you need to choose which ships get the handler yourself, use the other option:

:2) In your script's ''shipSpawned'' handler, once you have decided that a ship should get your ''shipTakingDamage'' override:

if (worldScripts.NShields && worldScripts.NShields.$shipHasShields(ship)) {
if (!ship.script._NShields_damageHandlers)
//set up the array if N-Shields hasn't run its shipSpawned handler yet
ship.script._NShields_damageHandlers = [];
ship.script._NShields_damageHandlers.push(my_shipTakingDamage_override)
} else {
//apply your handler override directly here
}

::Replace ''my_shipTakingDamage_override'' with your handler name.

=== function to configure NPC ship ===

N-Shields makes available to other OXPs a function to configure the NPC's shields after awarding of any defense-related equipment to it:

worldScripts.NShields.$configureShip(ship)

This idempotent (i.e. can be called several times without adverse effects) function will configure the ship's shields taking into account any script_info properties defined and the equipments isntalled in the ship, like Shield Booster, Military Shield Enhancement, Energy Grid, Shield Cycler, etc.

== Downloads ==
latest version available on the Expansion Manager and here: [[Media:N-Shields-1.0.1.oxz|N-Shields v1.0.1]]

[http://wiki.alioth.net/img_auth.php/b/b0/N-Shields_0.7.oxz N-Shields 0.7] {{#downloads:N-Shields_0.7.oxz}} downloads

[http://wiki.alioth.net/img_auth.php/2/2d/N-Shields.oxz N-Shields 0.6.4] downloaded {{#downloads:N-Shields.oxz}} times

== Version History ==

1.0.2
* Fixes bug: once fully recharged, NPC and Thargoid shields didn't recharge anymore.

1.0.1 (by Dybal)
* Doesn't add shields to scoopable "ships" (that includes all variations of escape capsules, even if their primary role happens to be different from escape-capsule).
* Fixes bugs that broke idempotency of $configureShip (leading to infinite loops at damage handling if $configureShip was called twice on the same ship).
* Fixes bug that led to "invulnerable ship" if the ship's script had its own shipTakingDamage event handler.

1.0 (by Dybal)
* Drops support for Shield Cycler (and Shield Cycler Next) 1.x for NPCs.
* Creates idempotent function for OXPs to call to configure a NPC's shields.
* Encapsulates modifications of ship's energy to verify for NaN before assigning a value into ship.energy (to prevent "invulnerable ship" bug).
* Adds delay to shipSpawned before setting up the ship to allow other OXPs' shipSpawned to award equipments.
* Configures shield recharge rate with Energy Grid (civilian and naval) upgrades if the NPC has them installed.
* Configures both Military Shield Enhancement and Shield Enhancer for NPCs.
* Doesn't award Shield Cycler to NPCs that have Shield Equalizer.
* Fixes bugs in handling of damage to subentities.
* Standardizes script object properties names: functions references start with '$' (except event handlers), everything else starts with '_';

0.7.1
* Fixed missing "use strict" in N-Shields.js.
* Removed Ship Configuration compatibility script entry from world-scripts.plist (the actual script was removed in 0.7.0).
* Reduced Thargoids' max shields (and compensatory energy reduction) slightly.

0.7
* Removed support for unusual/configurable shield types, except dorsal/ventral which now applies to Thargoids only, in order to simplify the scripts.
* Changed flashers from Ship entities to VisualEffects.
* Pre-defined flasher colour options: 3x Multicolour, Green, Blue.
* Hemisphere glow effects removed.
* New script_info keys NShields_flasherPreset, NShields_flasherKeys, max_shield_forward etc. to replace the now-unsupported NShields_colours, NShields_config.
* Config interface now works correctly (requires Oolite 1.83 or higher and Library OXP).
* Improved efficiency of hit-location code.
* Tentative support for Shield Cyclers on NPCs.

0.6.4
* Fixed bug in $locateHit cloaked-attacker handling (missing a ".position" or two).

0.6.3
* Fixed some bugs in NPC Equipment Damage compatibility code

0.6.2
* Fixed bug in manifest (missing "}").

0.6.1
* Added correctly functioning shipconfig version check and fixed small variable non-declaration in $drawSparks

0.6
* Added user-friendly configuration options via Library OXP.
* Hemisphere glow effects now work, although they still look awful.
* Added compatibility with NPC Equipment Damage OXP.

0.5.4
* Removed non-functioning version check; tested & corrected quaternion multiplication.

0.5.3
* Added version check in NShields-shipconfig-compatibility.js as requested by phkb

0.5.2
* Attempt to fix buggy aft shield effect orientation by using quaternion multiplication. Untested due to oolite-trunk launching error.

0.5.1
* Fixed bug in subentity shielding code which didn't check whether a shipTakingDamage handler had been stored before trying to call it
* Added hemisphere glow effects (disabled by default because very under-debugged & not really working yet)

0.5
* Added explosion-based shield effects.

0.4
* Improved recharge code for fore/aft shields works more like the core player version.
* Correct handling of heat damage (hopefully?).
* $locateHit now attempts to identify a cloaked attacker if the parameter passed is null.
* Added dorsal/ventral shield configuration option and changed Thargoid default to use this.
* Fixed bug in $configureShieldsFromArray which caused Thargoid shield config failure.

0.3
* New features: Player shield effects, NPC shields protect subentities, spark effects for unshielded hits.
* Support for Ship Configuration OXP's shield upgrades/downgrades.
* Fixed bug in recharge code which resulted in excessive energy drain.
* Not released.

0.2
* Extensive re-write implementing some configuration options.
* 'single' and 'fore/aft' shield types supported.
* Damage handler array added for compatibility with other OXPs.
* Not released.

0.1
* Very basic shield simulation. Not released.

== Quick Facts ==

{{OXPLevel|4}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Medium"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
{{Infobox OXPb| title N-Shields
|version = 1.0.2
|release = 2020-12-02
|license = CC-BY-SA 3.0
|features = Provides shields for NPCs.
|category = Mechanics OXPs
|author = [[User:Ngalo|NGalo]]
|feedback = [http://www.aegidian.org/bb/viewtopic.php?f=4&t=18127 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

== Links ==
*[[User:Ngalo|Commander Ngalo's other OXP's]]

*[[CustomShields]] - flashy 2012 equivalent (features visible damage effects)
*[[NPC-shields OXP]] - Commander McLane's original OXP in this area (2011-2)

*[[Cheating]] - see discussion on anti-cheating...

{{equipment-OXP}}

N-Shields

2022-10-26T23:10:26Z

Dybal: /* Quick Facts */

== Description ==
Gives NPCs highly customizable shields, with the default setting (as in [[CustomShields]]) being a 'fair' emulation of the player's shields.

Features:

- Fair shield recharge code (CustomShields didn't charge shields until energy banks were full)

- Acts as a hub for handling damage to NPCs, calling damage handlers from other OXPs after the shields are depleted and the damage reach the ship's hull, providing better compatibility for other OXPs with shipTakingDamage overrides

- Thargoids get dorsal/ventral shields. Support for other very non-standard shield configurations was attempted but removed in version 0.7 to simplify the code.

- More customisable colours. The default multicolour set goes from green down to red for standard shields, extending to blue/purple with upgrades.

- New visual effects based on explosions.plist for shields and unshielded hits.

- Awards Shield Cycler for a percentage of the ships that don't have them, configures Shield Booster and Military Shield Booster for NPCs that have them, apply shield recharge enhancements from Energy Grid (civillian and naval) for ships that have them.

== Settings in N-Shields.js scripts ==

There are some settings that can be modified in N-Shields script no change tnhe OXP behaviour:

* <code>this._NPC_shields = true;</code>
:Switch simulated shields on or off. If false, visual effects will be drawn based on energy level.

* <code>this._Thargoid_shields = true;</code>
:As above, but applies to Thargoids.

* <code>this._Thargoid_energyReduction = true;</code>
:Reduce Thargoids' energy banks to balance their new shields.

* <code>this._NPC_flasherColours = 1;</code>
:Pre-defined flasher list to use for standard NPC shields.
:Options:
::0: "_multicolour1", simple and bright
::1: "_multicolour2", slightly different colours, reduced alpha when low
::2: "_multicolour3", reverse colour order (red high, blue low)
::3: "_green", the Thargoid default (but can be used for other NPCs too)
::4: "_blue", various shades of blue

* <code>this._Thargoid_flasherColours = 3;</code>
:Colour for Thargoid shields, options as above.

* <code>this._flasherScale = 1;</code>
:Scale factor for flasher effects.

== Notes for OXP developers ==

=== scriptInfo properties ===

N-Shields looks for the following ship's scriptInfo properties:
* <code>npc_shields = "no";</code>
: N-Shields ignores the ship and doesn't do anything.

* <code>NShields_flasherKeys = ("myRed1", "myRed2", "myRed3", "myRed3", "myRed4");</code>
: A list of partial effectdata.plist keys, which will be prefixed with "N-Shields_flasher_" to obtain the full key for each flasher or other visualEffect.
: Ordered from lowest shield level to highest in 32-point increments.

* <code>NShields_flasherPreset = 3;</code>
: Number indicating one of the pre-defined flasher lists.
: See above for available options.

* <code>max_shield_aft = 128;</code>
* <code>max_shield_forward = 128;</code>
* <code>shield_recharge_aft = 2.0;</code>
* <code>shield_recharge_forward = 2.0;</code>
: Customise shield levels and recharge rates for this ship.
: The example above shows the standard default shields.
: Note that these can apply to player ships as well as NPCs.
: For Thargoid vessels, use 'upper' and 'lower' instead of 'forward' and 'aft'.

* <code>NShields_energyReduction = 128;</code>
: Specify an energy-bank reduction which will be applied when shields are set up.
: This is intended for two purposes:
::1) For mission ships, to prevent already-difficult opponents becoming impossible
::2) For ships which are 'supposed' to have strong shields, but 'fake it' with bigger energy banks when N-Shields is not installed.

* <code>NShields_exploders = ("NShields-explode-ring-red")</code>
: Custom exploder effect list. The example would make your ship spawn red(ish) ring explosions when its shields are hit.

* <code>NShields_protect_subentities = "no";</code>
: If defined as shown, shields will not protect frangible subentities on this ship.
: The subentities may be left exposed, or given their own shield configurations like any other ship.

The script_info keys "NShields_config" and "NShields_colours" are no longer supported.

=== Compatibility with other shipTakingDamage handler overrides ===

N-Shields provides an array onto which other OXPs can push their NPC ''shipTakingDamage'' handlers instead of actually overriding the handler in the ship script. Functions in this array will imitate the player's world-script ''shipTakingDamage'' handler; that is, they are called for every hit but with the 'amount' parameter only conveying damage which actually penetrated the shields (0 if the hit was entirely absorbed by shields). This approach ensures your handler will be called in the same manner regardless of OXP loading order and avoids any need for your OXP to detect which shield was hit and whether it's still up.

There are two ways to use this feature:

:1) In your script's ''startUp'' handler:

if (worldScripts.NShields && worldScripts.NShields.$shipHasShields(ship)) {
worldScripts.NShields._damageHandlers.push(my_shipTakingDamage_override)
} else {
//apply your handler override directly here
}

::Replace ''my_shipTakingDamage_override'' with your handler name.
::This approach applies your handler to all ships which have simulated shields, but not to those which don't. If you need to choose which ships get the handler yourself, use the other option:

:2) In your script's ''shipSpawned'' handler, once you have decided that a ship should get your ''shipTakingDamage'' override:

if (worldScripts.NShields && worldScripts.NShields.$shipHasShields(ship)) {
if (!ship.script._NShields_damageHandlers)
//set up the array if N-Shields hasn't run its shipSpawned handler yet
ship.script._NShields_damageHandlers = [];
ship.script._NShields_damageHandlers.push(my_shipTakingDamage_override)
} else {
//apply your handler override directly here
}

::Replace ''my_shipTakingDamage_override'' with your handler name.

=== function to configure NPC ship ===

N-Shields makes available to other OXPs a function to configure the NPC's shields after awarding of any defense-related equipment to it:

worldScripts.NShields.$configureShip(ship)

This idempotent (i.e. can be called several times without adverse effects) function will configure the ship's shields taking into account any script_info properties defined and the equipments isntalled in the ship, like Shield Booster, Military Shield Enhancement, Energy Grid, Shield Cycler, etc.

== Downloads ==
latest version available on the Expansion Manager and here: [[Media:N-Shields-1.0.1.oxz|N-Shields v1.0.1]]

[http://wiki.alioth.net/img_auth.php/b/b0/N-Shields_0.7.oxz N-Shields 0.7] {{#downloads:N-Shields_0.7.oxz}} downloads

[http://wiki.alioth.net/img_auth.php/2/2d/N-Shields.oxz N-Shields 0.6.4] downloaded {{#downloads:N-Shields.oxz}} times

== Version History ==

1.0.1 (by Dybal)
* Doesn't add shields to scoopable "ships" (that includes all variations of escape capsules, even if their primary role happens to be different from escape-capsule).
* Fixes bugs that broke idempotency of $configureShip (leading to infinite loops at damage handling if $configureShip was called twice on the same ship).
* Fixes bug that led to "invulnerable ship" if the ship's script had its own shipTakingDamage event handler.

1.0 (by Dybal)
* Drops support for Shield Cycler (and Shield Cycler Next) 1.x for NPCs.
* Creates idempotent function for OXPs to call to configure a NPC's shields.
* Encapsulates modifications of ship's energy to verify for NaN before assigning a value into ship.energy (to prevent "invulnerable ship" bug).
* Adds delay to shipSpawned before setting up the ship to allow other OXPs' shipSpawned to award equipments.
* Configures shield recharge rate with Energy Grid (civilian and naval) upgrades if the NPC has them installed.
* Configures both Military Shield Enhancement and Shield Enhancer for NPCs.
* Doesn't award Shield Cycler to NPCs that have Shield Equalizer.
* Fixes bugs in handling of damage to subentities.
* Standardizes script object properties names: functions references start with '$' (except event handlers), everything else starts with '_';

0.7.1
* Fixed missing "use strict" in N-Shields.js.
* Removed Ship Configuration compatibility script entry from world-scripts.plist (the actual script was removed in 0.7.0).
* Reduced Thargoids' max shields (and compensatory energy reduction) slightly.

0.7
* Removed support for unusual/configurable shield types, except dorsal/ventral which now applies to Thargoids only, in order to simplify the scripts.
* Changed flashers from Ship entities to VisualEffects.
* Pre-defined flasher colour options: 3x Multicolour, Green, Blue.
* Hemisphere glow effects removed.
* New script_info keys NShields_flasherPreset, NShields_flasherKeys, max_shield_forward etc. to replace the now-unsupported NShields_colours, NShields_config.
* Config interface now works correctly (requires Oolite 1.83 or higher and Library OXP).
* Improved efficiency of hit-location code.
* Tentative support for Shield Cyclers on NPCs.

0.6.4
* Fixed bug in $locateHit cloaked-attacker handling (missing a ".position" or two).

0.6.3
* Fixed some bugs in NPC Equipment Damage compatibility code

0.6.2
* Fixed bug in manifest (missing "}").

0.6.1
* Added correctly functioning shipconfig version check and fixed small variable non-declaration in $drawSparks

0.6
* Added user-friendly configuration options via Library OXP.
* Hemisphere glow effects now work, although they still look awful.
* Added compatibility with NPC Equipment Damage OXP.

0.5.4
* Removed non-functioning version check; tested & corrected quaternion multiplication.

0.5.3
* Added version check in NShields-shipconfig-compatibility.js as requested by phkb

0.5.2
* Attempt to fix buggy aft shield effect orientation by using quaternion multiplication. Untested due to oolite-trunk launching error.

0.5.1
* Fixed bug in subentity shielding code which didn't check whether a shipTakingDamage handler had been stored before trying to call it
* Added hemisphere glow effects (disabled by default because very under-debugged & not really working yet)

0.5
* Added explosion-based shield effects.

0.4
* Improved recharge code for fore/aft shields works more like the core player version.
* Correct handling of heat damage (hopefully?).
* $locateHit now attempts to identify a cloaked attacker if the parameter passed is null.
* Added dorsal/ventral shield configuration option and changed Thargoid default to use this.
* Fixed bug in $configureShieldsFromArray which caused Thargoid shield config failure.

0.3
* New features: Player shield effects, NPC shields protect subentities, spark effects for unshielded hits.
* Support for Ship Configuration OXP's shield upgrades/downgrades.
* Fixed bug in recharge code which resulted in excessive energy drain.
* Not released.

0.2
* Extensive re-write implementing some configuration options.
* 'single' and 'fore/aft' shield types supported.
* Damage handler array added for compatibility with other OXPs.
* Not released.

0.1
* Very basic shield simulation. Not released.

== Quick Facts ==

{{OXPLevel|4}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Medium"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
{{Infobox OXPb| title N-Shields
|version = 1.0.2
|release = 2020-12-02
|license = CC-BY-SA 3.0
|features = Provides shields for NPCs.
|category = Mechanics OXPs
|author = [[User:Ngalo|NGalo]]
|feedback = [http://www.aegidian.org/bb/viewtopic.php?f=4&t=18127 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

== Links ==
*[[User:Ngalo|Commander Ngalo's other OXP's]]

*[[CustomShields]] - flashy 2012 equivalent (features visible damage effects)
*[[NPC-shields OXP]] - Commander McLane's original OXP in this area (2011-2)

*[[Cheating]] - see discussion on anti-cheating...

{{equipment-OXP}}

File:N-Shields-1.0.2.oxz

2022-10-26T23:09:21Z

Dybal: Version 1.0.2

== Summary ==
Version 1.0.2

Towbar

2022-10-26T00:11:32Z

Dybal: /* Changelog */

Make money from derelict ships.
[[Image:Towbar1.png|600px|right]]
== Towbar ==

Pilots often eject when they have lost a fight and thus leave behind an almost destroyed ship.
You do not need to totally destroy these ships anymore for the bounty, because now you will get it instantly when the pilot ejects.

Your HUD can show the Derelict status of your target if either [[Detectors]] OXP or [[Numeric_Style_HUDs|NumericHUD v3.11]] OXP are installed or you insert the insertintohudlegends.plist file from the Towbar OXP into your hud.plist.

If you approach a derelict ship within 100m (or hurtle into it) with a low speed difference (below 10) then the towbar will lock it. You will see it in your aft view (F2).

''You can tow ships with a maximum of 1.6 times more mass than your ship''. Untowable ships can be mined with Ship Miner only (see below).

You cannot use Injectors unless you have special equipment and your pitch rate will be very low while towing (the $TowbarSlowTurn variable in towbar.js can be set to false on computers where controls go jerky while towing a ship).

Tow the ship into a dock in the current solar system to sell the hull as a large amount of alloys.

Ship Mass Alloys Approximated ₢
Adder 11 3 100
Moray 40 12 400
Cobra Mk I 47 14 500
Fer-de-Lance 51 15 500
Asp 59 18 600
Cobra Mk III 186 56 1800
Boa 192 58 1900
Python 222 67 2200
Anaconda 430 80 2600

[[Image:Towbar2.png|400px|right]]
The payment is calculated from the alloy price at the station where you sell it, plus 0-2TC Computers (depending on the ship size). The largest ships can give a maximum of only 80TC alloys due to their massive inner space. These alloys will not be added to the market because the ship is sold to a dealer who pays instantly but disassembles the wreck later (thus avoiding filling up the 127TC limit of the station's market). You will get several hundred credits for each saved piece of equipment, and for the weapons too. A [[Military_Laser|Military Laser]] will be worth 1-2 thousands (but probably the fight was harder to get it).

Cargo will be added to the market. All saved cargo is sold for the current price at the station. If the market is already filled with this cargo then the remains will be sold at half price (or discarded if you set $TowbarLimit127t to true in towbar.js).

Some ships (with high version numbers in [[ShipVersion]] OXP - so the more durable ones) hold much more valuable cargo than others.

[[Image:Towbar3.png|400px|right]]

With [[HardShips]] OXP you can get more equipment - as you can see in this image:

'''Compliments'''

You might get the following compliments:

* 1000₢: Nice work.
* 3000₢: Well done!
* 5000₢: Excellent!

'''Usage'''

Be careful when attacking a ship you hope to tow: slow your fire when the exhaust plume changes (or throwing sparks with [http://aegidian.org/bb/viewtopic.php?f=4&t=12507 CustomShields OXP]) to avoid blowing it up - and stop immediately when you see the Escape capsule. Then slowly touch the derelict ship to lock it to your towbar.

Reduce the pitch and yaw movements when towing. There is a small but increasing chance to break either the towbar or the towed ship: heavier ships break sooner. A few tips:
* Approach the derelict ship in the direction of your next movement, usually head to the Station to reduce turning with mass.
* Stop your ship before turning to cause less pressure to the towbar.
* Do not go on a sightseeing tour: the status of the ship degrades over time when moving, so you will earn more credits if you deliver it faster. You will be informed about flying parts to remember this. Such loss will be less at low speeds and your haul will be safe from this only if your ship is stopped!

Problems:
*If the towbar is destroyed then you can buy another and go back to the ship, just find the '''"D"''' (derelict) beaconCode on your [[Advanced_Space_Compass|Advanced Space Compass]]. [[Telescope]] OXP shows it also on your main scanner from any range.
*If you are too slow then either pirates will blow up the ship for the cargo, or hunters for the bounty or else some Thargoids will visit for sure!
*Other derelict ships in the system will not display a beaconCode on your ASC (due to the signal transmitter only being placed when the towbar is locked on).

Releasing the towed ship:
*You can release your towed ship if your ship touches another derelict ship.
*If you initiate a hyperjump then the towbar will release the towed ship. This means that you must sell the ship in the same system where you get it.
*You can also release the towed ship by priming your Towbar ('''Shift+N''') and pressing activate ('''n'''). The just released ship can then be relocked by another activate (within 200m).

Combat while towing:
*The towed ship is vulnerable, so you are recommended to avoid combat situations until it has been delivered.
*The largest towed ships face into your aft weapon - so you cannot fire it or you will destroy the towed ship! If you really ''must'' fire your rear laser, then release the ship by a double "h" keypress (start and stop a hyperjump) and pick it up again later. Before doing this you must have set a target system ''and'' have enough fuel for the jump.
*Do not engage in a fight while towing a ship (to avoid too much jerky movement which breaks the towbar). If you must, then, as above, release your towed ship and reclaim it after the battle.

Build up your reputation by salvaging more ships, (towing missions will require qualifications)!

Cost: 100.0₢
Techlevel: 1

==Laser Reductor==

This reduces your Laser power to minimal if your targeted enemy ship is derelict (to prevent you destroying it after the pilot has ejected).
You will get a "Derelict!" message with a "bloop" sound when your target is ejected to warn you to stop firing your laser.

Your first 10 hits will be reduced only, (''ie'' an entire second with a continuously firing beam laser). Most pilots are able to release the fire button within a second after warning sound started: if you fluff this then increase the $TowbarMaxReduct variable in towbar.js.

When you exceed this limit a "Laser Reductor disabled" message appears and you can now destroy your target to complete your mission.
You can turn off the reductor by priming (Shift-N) and activating (n) Towbar when there is neither a towed ship nor a derelict one within 200m.

It is recommended to install the "Derelict" display warning into your HUD (with either Detectors OXP, NumericHUDv3.11 or by following the instructions in the insertintohudlegends.plist file) to get another visual warning.

Cost: 100.0₢
Techlevel: 5

==Ship Miner==

Complex robots can transfer the valuable parts of the towed ship to your cargo hold - but this takes some time.

Mining operates in the following order:
:1. '''Cargo''': stronger ships tend to hold more valuable packages. Fuel is also transferred in this step.
:2. '''Computers''': from the built-in electronics, usually 1 or 2t depending on the ship size.
:3. '''Machinery''': from mining equipment and lasers, in equal value.
:4. '''Alloys''': from dismantling the hull into pieces - but only the smaller pieces can fit into the scoop (max. 10t).

Mining will stop by default when the cargo transfer is done - assuming you want to tow the ship into a station.

To continue mining the ship, prime Towbar ('''Shift+N''') and press mode ('''b'''): but this is suggested only if you do not plan to tow the ship back to any dock.
* Set back to the "'''Offline'''" or "Cargo only" settings if you plan to tow a ship again.
* The "'''Cargo only'''" mode is suggested due to possible loss of cargo from the towed ship while moving (which cannot happen from your cargo hold).
* The "'''Up to full'''" mode will mine until there is no free space left in your ship, the rest is left in the half-mined ship.
* The "'''Salvager'''" mode will drop out all mined inner parts into space to complete the mining operation and increase your salvager reputation regardless of whether your hold is full.

Cargo check needs some time (even for ships with 0t cargo) due to checking the cabin safe which can contain valuables.
Mining will be paused while steering, speed changing, injecting and torus travel - so it is best to mine when stopped or while travelling straight at a constant normal speed.

=== Parcels ===

Sometimes you can find parcels when finishing cargo transfer. Urgent ones need to be delivered to the main station within a few minutes.
Your ship's manifest screen (F5F5) will show the remaining time for delivery. Do not use autodock (Shift+C) due to it needing 20 minutes (regardless of the fact that it looks like an instant process!) - you will arrive too late.

Your parcel reputation will not suffer if you do not arrive in time due to you are not the one who undertook the delivery (expired parcels will be removed from your manifest screen to avoid such penalties).
Install [[Display_reputation_OXP|Display reputation OXP]] to track your progress: you will get more payout for the same work if you earn a higher reputation.

To find the shortest route for normal parcel delivery you should buy Advanced Navigational Array equipment, then select the galactic chart (F6F6), hold down "^" (Shift+6) and click on the destination (marked with a green diamond). Hold down the Ctrl key as well also to show the fastest route if that route takes too long. Press F1 and then "`" to review your time limit in your communications log in hours. The Manifest screen (F5F5) shows this in days but in the galactic chart (F6F6) you see the times of routes in hours.

=== Traps ===

Some ships are equipped with a self-destruct trap. A mistake during Fuel transfer can also end up with an explosion. These can cause major damage to your ship depending on the size of the towed ship. As you gain more and more salvaging experience you can prevent these problems more of the time. With [[ShipVersion]] OXP you usually can mine ships safely below or at your salvager level.

Towbar will not autolock if a trap can kill you due to the target being too large or your energy too low. You can override this safety feature by priming and activating Towbar but you risk dying in an explosion. There is always a small chance to fall into a trap, sometimes even an Elite Salvager can make mistakes also! It might be more prudent to avoid overriding this safety feature and wait until your energy and shields are recharged, buying Shield Boosters or even buying a larger ship with more energy banks.

Ship mining is not 100% safe, towed ships can explode from the meddling in rare cases which will surely also destroy the miner.

Finishing mining counts as 'salvaging the ship' which increases your reputation - so you can save the towing time by doing so if the money is less important to you.

The "'''Empty'''" word in the ship name means that the cargo has been transferred already, the "'''Mined'''" word means that mining is completed.
Your HUD can show these words also with [[Numeric_Style_HUDs|NumericHUD v3.11]] or by following the instructions in the insertintohudlegends.plist.
Derelict ships show as a light blue lollipop in the scanner when targeted, Empty ships show as blue and Mined ships show as dark blue.

If you want to sell the parts in another solar system then you must mine the ship before jumping (due to the impossibility of constructing a tool which can avoid the explosion of a badly damaged ship in hyperspace).

You should also complete mining if you are very far away from any dock to avoid losing many of the parts along the way. If the Station is nearby you will earn more credits by towing it as it is.

If you are mining a heavy ship which has more than 1.6 times the mass of your ship, then you are stuck and cannot move regardless of your speed settings. If you touch the controls while mining a heavy ship then you must release it immediately to avoid breaking the towbar.

Ship Miner can fit into large ships over 130t only and the mined parts need much cargo space, unless you found valuable cargo (Gold, Platinum or Gem-stones).

Cost: 20,000.0₢
Techlevel: 5

==Ship Miner Assistant==

Additional transporter bots can help to reduce the mining time and increase your safety.
The possibilities of losing or destroying ship parts are roughly halved.
These can also catch large parts when towing before they drop out of the towed ship.

Cost: 20,000.0₢
Techlevel: 11

==Towbar Compatible Injectors==

Allow the use of Injectors while towing a ship.
Costly due to the need of stronger towbar holders and of new exhaust fittings so that the towed ship is not damaged by exhaust emissions.

The towed ship loses more parts if the speed is higher - so you do not save money but you can save time.
Torus Drive is the only exception to the speed rule - so Torus is recommended for use as soon as possible.
Do not alter your direction while using these injectors otherwise your towbar will become much more unstable.

Cost: 20,000.0₢
Techlevel: 11

==Towbar Repair Bot==

Can fix a broken towbar, but once only.
Repair starts automatically when needed and takes about a minute.

The bot cannot repair a destroyed towbar - which happens almost as often as a broken one - so it is better to apply a Towbar Stabilizer, and use the repair bot as a last resort only.

Cost: 1,000.0₢.
Techlevel: 5

[[File:Equipment Icons.png|thumb|400px|right|'''Equipment Icons''' 
'''Towbar''' (2): Towbar Stabiliser, TugDrone 
(Deep Space Dredger (1): Salvage Missile) 
(Cargo Shepherd (1): Cargo Shepherd)]]
==Towbar Stabilizer==

Use this when your towbar is unstable - it will prevent damage and the possible explosion of your towed ship.
It occupies an empty pylon, and is launched as a mine.
Buy more than one if you plan to tow heavy ships for long distances.

It cannot fix a broken or destroyed towbar, nor resurrect a towed ship after an explosion caused by unstable towing: so use it before these problems occur.

Cost: 200.0₢
Techlevel: 5

==Tug Drone==

[[Image:Towbar10.png|400px|right]]
Launch as a 'fire and forget missile' at a derelict ship and you are done with the work!
Managed by the local authorities who charge a 50% commission but also pay up instantly when your tug drone hits the target.

The drone will eject the cargo and pay you for the ship only: so you must scoop the ejected cargo if you have not already extracted it with Ship Miner before launching your Tug Drone.
GalCop defends tug drones but the cargo ejection is due to the need for all pirates to know that tug drones never transport cargo (thus attaining a tolerable safety level where it is not worth the pirate's efforts to attack it).

[[Deep_Space_Dredger|Deep Space Dredger]] OXP provides a '''Salvage Missile''' which can autopilot a derelict ship with cargo.
In this case you must escort the derelict until it reaches a Dredger. This can be much harder due to pirate ambushes, but can also pay more due to avoidance of the local authorities' commission.

A Tug Drone can only fit into large ships (over 130TC).
Do not target small ships which pay less than the cost of the Tug Drone!
You must aim exactly at the target (''ie'' with a red [[STE]] box) to launch the drone, the regular green target lock is not exact enough.

The rotating ship model cannot be displayed in the sell salvage screen during flight, and your ship is moving while you read it so press enter shortly to reduce the blind fly time.

Cost: 1,000.0₢
Techlevel: 5

==Salvager License==

[[Image:Towbar9.png|400px|right]]
GalCop regulates ship salvaging at main stations; you must buy a license from your initial earnings, which is automatically deducted. You will only receive payments for the cargo after you have pooled the full 20,000 credits for the yearly license. You must buy a new license every year. Once you have a Salvager License, you must pay tax on the ship hull and equipment valuations based on the government type.

Government Tax
Anarchy 0 %
Feudal 5 %
Multi-Governmental 10 %
Dictatorship 15 %
Communist 20 %
Confederacy 25 %
Democracy 30 %
Corporate State 35 %

Non-GalCop stations do not require a license, but ''do'' charge a 50% commission. Dredgers in [[Deep_Space_Dredger|Deep Space Dredger]] OXP and Salvage Gangs in [[Anarchies_OXP|Anarchies]] OXP buy without commission due to processing the ship locally but they pay a low price for the alloys of the hull.

Cargo is never taxed or commissioned.

==Salvager Missions==

Your reputation is determined by how many ships you have salvaged either by delivery or by fully mining them.
When you reach certain levels of reputation you might embark on Salvager Missions (in v0.93 only the first of these is implemented):

Ships Rank Level Payout (₢) Need new Salvager License
0 First Aid Easy 1,000 No
2 Second Hand Easy 2,000 No
10 Ten Commands Easy 10,000 Yes
20 Twenty Sisters Medium 20,000 No
30 Thirty Pirates Medium 30,000 Yes
40 Forty Robbers Medium 40,000 Yes
50 Fifty Percent Hard 50,000 No
100 Hundred Tonnes Hard 100,000 Yes
200 200 Seconds Hard 200,000 No

==Salvager Rankings==

You can step up in your Salvager career by towing or mining derelict ships or achieving salvage missions.

As your reputation increases you can attain better rankings which are shown in your Manifest screen (F5-F5).

With higher ranks you can neutralize more complex traps in towed ships.

Ships Rankings
2 Novice Salvager
4 Assistant Salvager
8 Poor Salvager
16 Below Average Salvager
32 Average Salvager
64 Above Average Salvager
128 Competent Salvager
1000 Trustworthy Salvager!
3000 Infallible Salvager!
6000 Elite Salvager!

==Equipment Payout==
In v0.104, Towbar started supporting "pluggable" policies to calculate the value of the equipments, weapons included, in the salvaged ship, to be implemented by other OXPs.

The reason for that can be seen [http://bb.aegidian.org/viewtopic.php?p=270538#p270538 in this discussion].

In v0.104, those policies overwrite the standard policy - to change policies the player has to uninstall one policy OXP and install the other policy OXP, which requires exiting the game session. Payout OXPs compatible with the v0.104 version must have a single policy packaged inside.

After v0.105, Towbar supports in-game selection of the payout policy through the Station Interfaces (F4) ''Config for AddOns'' screen. Payout OXPs compatible with v0.105 could package more than one payout policy for the player to choose, but if an OXP packages more than one policy it is not compatible with Towbar v0.104.

The OXPs that package such alternative payout policies can be found [[Towbar_Payout|here]].

== Technical Information ==
Requires Oolite v1.77 and the [[BGS]] OXP if you want to see a nice background on the salvage screen.

=== Configuration ===
Towbar allows in-game configuration through Station Interfaces (F4) ''Config for AddOns'' for:

* TalkingShip: when true, Towbar will use Comms to send its messages to the player; otherwise the messages go to the Console.
* StartMode: start mode for Ship Miner: 0=Offline, 1=Cargo Only, 2=Full, 3=Salvager[.
* Appearance: the Towbar equipment appearance: 0=Retractable, 1=Fixed, 2=Tractor Beam.
* EqPayout: the salvaged equipment Payout Policy to use

Other configurations can only be altered by editingtowbar.js and re-starting the game:

* $TowbarDebug = false; //will spawn a derelict ship right after undock
* $TowbarLimit127t = false; //can limit markets to their original capacity (127t)
* $TowbarMaxReduct = 10; //how many hits will be reduced by the Laser Reductor on a derelict ship
* $TowbarNPCMissile = true; //NPCs with enhanced IQ: fire a missile before ejecting as a last resort
* $TowbarSlowTurn = true; //set to false if causing jerky controls while towing a ship

=== Payout OXPs ===

Payout OXPs add alternatives to the standard salvaged equipment payout policy. Such alternatives can be pro-player, paying more for the equipment, or anti-player, paying less.

A Payout Policy OXP MUST:

* create a function that takes an ''EquipmentInfo'' (which might contain a weapon) object as parameter and returns its salvage price IN CREDITS;
** if the ''scriptInfo'' property ''towbar_max_salvage_price'' is defined for an equipment, the value there MUST be the high limit for the payout returned by the function for that equipment;
* in the OXP's startUpComplete event handler:
** append a reference to that function to the array ''worldScripts.towbar.$TowbarEquipmentPayoutHandlers''; 
** define a property ''display'' for that function and assign a short and distinctive string to it - the first 6 characters will be used to identify the policy implemented by the function in the policy selection screen; 
** repeat for as many policies as wished (but bear in mind that all the policies short names will have to fit in a single line). 

=== License ===
*This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 3.0
*If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.
::Towbar applause sound source: http://soundbible.com/1260-Auditorium-Applause.html
::Towbar break sound source: bgs-c_hullbang.ogg in BGS OXP.
::Towbar fireworks sound source: http://soundbible.com/693-Fireworks-Finale.html
::Towbar hit derelict sound source: boop.ogg in Oolite.
::Towbar lock on sound source: bgs-m_fx_shipyard1.ogg in BGS OXP.

=== Changelog ===

2022.10.25, v1.1

* Adds descriptive label for the beacon added to the ship when towbar locks on it for towing.
* Fix mission texts to mention the name of the actual station near which the mission ship is located (instead of always the main station).
* Only outputs message about releasing towed ship when towbar is damaged when a ship is towed (towbar might be damaged when not in use).
* Fix repair costs for Towbar and Towbar Compatible Injectors to discount the full price (which are proportional to the ship's mass).
* Healthy ships (i.e, undamaged ships and usable derelicts) don't lose stuff (cargo and equipment) when towed.
* Checks if Library OXP is installed before attempting to register the configuration options.
* Moves Tug Drone towed-ship processing to towbar worldscript.
* Do not look for the market commodities if in interstellar space.

2020.11.04. v1.0

* Just ups the version number to 1.0.

2020.11.03. v0.110

* Fixes bug in the verification of player ship's mass before offering the mission after towbar is bought.
* Towbar equipment salvage payout pricing looks at the equipment's scriptInfo property 'towbar_max_salvage_price' to limit the salvage price of equipments (useful for money-sinks like Shield Cycler Manual Configurator Standard and Advanced).

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">

2020.10.03. v0.109

* Towbar and Towbar Compatible Injectors have prices proportional to the ship's mass.
* Don't start the mission after the player buys towbar if the player's ship has less than 30t.
* Re-enables injectors after releasing the towed ship when hitch-riding a wormhole.
* Reduces the amount retained for the Salvager's License when salvaging at main station without a license from 100% to 60%.
* Uses $disableEquipemnt and $enableEquipment from Rapair Bots if available to disable/enable the injectors when towing without towbar compatible injectors.
* Stations with GalCop allegiance behave as main station.
* Player may choose to pay the full balance to the Salvager's License if enough credits are available.

2020.09.14. v0.108

* Deals with carried ships when salvaging a Carrier.

2020.09.04. v0.107

* Fixes bug that halted salvaging processing.
* Fixes bug that prevented Appearance parameter saved value from taking effect after loading from save file.
* More messages re-written to better English (thanks to Nite Owl).
2020.08.31. v0.106

* Fixes a bug in the fallback code for Laser Reductor.
* Doesn't blindly remove equipments defined by other OXPs.

2020.08.29. v0.105

* Fixes bug in cargo pod script that looks at the pod's cargo space instead of the player ship's when scooped.
* Implements salvaged equipment payout policy selection in-game through Stations Interfaces (F4) Config for AddOns.
* Laser Reductor looks at EquipmentInfo.weaponInfo.damage to know the energy of the hit to be reduced (uses a fallback for core game versions that don't allow scripts retrieval of weaponInfo).
* Creates TalkingShip, StartMode and Appearance parameters in Stations Interfaces (F4) Config for AddOns.
* Implements TalkingShip, with messages in better English thanks to Nite Owl.
* Removes the "Incoming Message" speech intro for Comms messages.

2020.08.10. v0.104

* Use commodity name instead of commodity display name as cargo identification in re-spawned cargo pods (with display name as identification, the cargo couldn't be put into the player's ship manifest when the cargo pod was scooped).
* Adjusted Laser Reductor to take into account the damage rate defined for the current weapon.
* Debug code to spawn derelicts just out the station when launching now spawn near the station where the player's ship is docked instead of the main station.
* Tweaked code the awards/remove EQ_DTADER to reduce the number of times it's added/removed while targeted.
* Upped minimal Oolite version to 1.81, removed code for older versions.
* Fixed bug that used commodity display name instead of name in lost-in-transit cargo pods.
* Fixed bug that removed rotation when reducing yaw and pitch while towing (affected ILS rotation-sync).
* Fixed bug in salvaged ship payout when the ship's cargo is beyond the local market capacity.
* Re-factored salvaged equipment pricing into a function (to make it easy to overwrite it with different pricing policies through other OXPs).
* Included port and starboard weapons (if any) in the salvaged ship payout.
* Reduced payout for salvaged ship's equipment and weapons.
* Some de-referencing for performance.

2020.06.23. v0.103

* Abort sound was not playing if the tug drone can't be launched.

2020.05.05. v0.102

* Better integration with Email System, preventing unnecessary emails being sent.

2020.02.23. v0.101

* Fixed two invalid reference errors in the towbar mission script.
* Some minor spelling/grammar corrections.

2016.08.14. v0.99

* Increased payout for equipments and weapons during ship salvaging.
* Towbar is not shown by default, just when tow a ship (retractable).
* Mission failed screen appear correctly at load game when must finish without rest.
* NPC will not fire missile at point-blank range before eject, thanks to Astrobe.
* Fixed multiplied parcels, thanks to Cmd Northgate.
* Removed "x. find" from parcel messages, suggested by Cmd Northgate.
* Fixed Constrictor hunt problem, thanks to Captain Obvious.
* First mission compatible with Escort Deck, thanks to Vincentz.
* Fixed for very long ships like Worker's Commuter in Commies OXP, thanks to TheOldGamer.
* Density of small-cargo1 raised to help scoop it with small ships, thanks to Bogatyr.
* Tug Drone got collision handler, thanks to Hullblazer.
* Ship Miner default mode changed to salvager as suggested by gt52

2015.03.15. v0.98

* Player get score if force a pilot to eject.
* Small fixes for Oolite 1.81 and without BGS.

2014.09.21. v0.97

* The first mission will fail if jump out from the system, thanks to Bogatyr.
* Cleanup after first mission: Moray removed, thanks to Falcon777.
* Trumbles modified to do not take over cargo, thanks to Falcon777.

2013.12.26. v0.96

* Bugfix in Tug Drone.
* Smaller large cargo box.

2013.12.14. v0.95

* Parcels and urgent parcels can be found during ship mining.
* Minor tweaks in mining and a bugfix with Trumbles.
* Audio and message warning if hit a derelict ship to stop fire in time.
* Laser Reductor limitation adjustable in $TowbarMaxReduct.
* Illegal cargo added into some ships with bounty.

2013.12.08. v0.94

* Laser Reductor fixed and can be turned off.

2013.10.23. v0.93

* Timed bomb implemented into some derelict ships.
* Traps are leveled up with [[ShipVersion]].
* Towbar will not autolock if a trap can be fatal.
* NPCs will stop attacking derelict ships.

2013.10.22. v0.92

* Trap ships and Fuel mining added (thanks to popsch).
* Injectors fixed when the towed ship destroyed by others.

2013.09.24. v0.91

* Give back Injectors after mission ship is delivered.
* Set $TowbarSlowTurn to false on computers where controls goes jerky when tow a ship.
* XML support in insertintohudlegends.plist.
* Effectdata.plist for Telescope OXP to show large cargo models.

2013.09.06. v0.9

* Laser Reductor, Ship Miner, Ship Miner Assistant and Tug Drone added.
* First Salvager Mission added.
* Towbar primeable to release and to change mining mode.
* Salvager Rankings displayed in F5-F5 screen (idea from Display reputation OXP).
* Deep Space Dredger and Salvage Gang buy ships without commission.
* Can lose or destroy alloys, cargo and equipments during towing and steering also.
* Flying out more t alloys and cargo in one large object instead of many 1t pieces.
* Flying equipments now scoopable as 1 or more t Machinery.
* The ship.script.$TowbarShipHealth is scalable from 0 to 1 (max. loss to no loss).
* Pitch rate less reduced with light towed ships.
* HUD can show the Derelict, Empty and Mined status of the current target.
* Pay bounty instantly when the target derelicted.
* Refund available for all equipments of this OXP.

2013.08.21. v0.8

* Chance to break the towbar or the towed ship (thanks to DaddyHoggy).
* Towbar break sound included, source: bgs-c_hullbang.ogg in BGS OXP.
* Towbar Stabilizer, Repair Bot and Towbar Compatible Injectors added.
* Towed ship get "D" (derelict) beaconCode.
* Build up reputation in missionVariables.
* Salvager License and tax system added.
* Flying alloys, cargo and equipments added.
* Ship moved to right in the sell salvage screen (thanks to Svengali and cim).

2013.08.18. v0.7

* Injectors offline and pitch rate very low when towing.
* Payment lowered.

2013.08.17. v0.6

* Lock on sound added. Source: bgs-m_fx_shipyard1.ogg in [[BGS]] OXP.
* Some ships carry much more valuable cargo than others.

2013.08.16. v0.5

* Give money for cargo also.

2013.08.15. v0.2

* Give money for equipments.

2013.08.14. v0.1

* First test files.
</div>

== Download ==

Download [[Media:Towbar-1.1.oxz|Towbar-1.1.oxz]].
*[[Media:Towbar-1.0.oxz|Towbar-1.0.oxz]].
*[[Media:Towbar-0.110.oxz|Towbar-0.110.oxz]].
*[[Media:Towbar-0.109.oxz|Towbar-0.109.oxz]].
*[[Media:Towbar-0.108.oxz|Towbar-0.108.oxz]].
*[[Media:Towbar-0.107.oxz|Towbar-0.107.oxz]].
*[[Media:Towbar-0.104.oxz|Towbar-0.106.oxz]].
*[[Media:Towbar-0.105.oxz|Towbar-0.105.oxz]].
*[[Media:Towbar-0.104.oxz|Towbar-0.104.oxz]].
*[[Media:Towbar_0.103.oxz|Towbar_0.103.oxz]].
*[[Media:Towbar_0.102.oxz|Towbar_0.102.oxz]].
*[[Media:Towbar_0.101.oxz|Towbar_0.101.oxz]].
*[[Media:Towbar_0.99.oxz|Towbar_0.99.oxz]].
*[[Media:Towbar_0.98.oxz|Towbar_0.98.oxz]] was downloaded {{#downloads:Towbar_0.98.oxz}} times.

== Links ==
*[http://www.aegidian.org/bb/viewtopic.php?f=2&t=2007 2006 discussion about towing derelicts]
*[http://www.aegidian.org/bb/viewtopic.php?f=2&t=4844 2008 Is destruction the only way?]
=== Other OXPs enhancing this one ===
*[[Deep Space Dredger]] - the dredger also plays a salvage role, and includes a Salvage missile
*[[BGS]] - for Towbar sounds
*[[Towbar Payout]] - there is currently only ''Medium'' available, but more are possible

== Quick Facts ==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Medium"|oxpMEM="Average"|oxpGPU="Low"|oxpIsParent=true|oxpIsChild=|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = Towbar
|version = 1.1
|release = 2022-10-25
|features = Introduces Salvaging.
|license = CC BY-NC-SA 4.0
|category = Activities OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=15204 BB-Link]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-violet.png]]

Towbar

2022-10-26T00:09:54Z

Dybal: /* Quick Facts */

Make money from derelict ships.
[[Image:Towbar1.png|600px|right]]
== Towbar ==

Pilots often eject when they have lost a fight and thus leave behind an almost destroyed ship.
You do not need to totally destroy these ships anymore for the bounty, because now you will get it instantly when the pilot ejects.

Your HUD can show the Derelict status of your target if either [[Detectors]] OXP or [[Numeric_Style_HUDs|NumericHUD v3.11]] OXP are installed or you insert the insertintohudlegends.plist file from the Towbar OXP into your hud.plist.

If you approach a derelict ship within 100m (or hurtle into it) with a low speed difference (below 10) then the towbar will lock it. You will see it in your aft view (F2).

''You can tow ships with a maximum of 1.6 times more mass than your ship''. Untowable ships can be mined with Ship Miner only (see below).

You cannot use Injectors unless you have special equipment and your pitch rate will be very low while towing (the $TowbarSlowTurn variable in towbar.js can be set to false on computers where controls go jerky while towing a ship).

Tow the ship into a dock in the current solar system to sell the hull as a large amount of alloys.

Ship Mass Alloys Approximated ₢
Adder 11 3 100
Moray 40 12 400
Cobra Mk I 47 14 500
Fer-de-Lance 51 15 500
Asp 59 18 600
Cobra Mk III 186 56 1800
Boa 192 58 1900
Python 222 67 2200
Anaconda 430 80 2600

[[Image:Towbar2.png|400px|right]]
The payment is calculated from the alloy price at the station where you sell it, plus 0-2TC Computers (depending on the ship size). The largest ships can give a maximum of only 80TC alloys due to their massive inner space. These alloys will not be added to the market because the ship is sold to a dealer who pays instantly but disassembles the wreck later (thus avoiding filling up the 127TC limit of the station's market). You will get several hundred credits for each saved piece of equipment, and for the weapons too. A [[Military_Laser|Military Laser]] will be worth 1-2 thousands (but probably the fight was harder to get it).

Cargo will be added to the market. All saved cargo is sold for the current price at the station. If the market is already filled with this cargo then the remains will be sold at half price (or discarded if you set $TowbarLimit127t to true in towbar.js).

Some ships (with high version numbers in [[ShipVersion]] OXP - so the more durable ones) hold much more valuable cargo than others.

[[Image:Towbar3.png|400px|right]]

With [[HardShips]] OXP you can get more equipment - as you can see in this image:

'''Compliments'''

You might get the following compliments:

* 1000₢: Nice work.
* 3000₢: Well done!
* 5000₢: Excellent!

'''Usage'''

Be careful when attacking a ship you hope to tow: slow your fire when the exhaust plume changes (or throwing sparks with [http://aegidian.org/bb/viewtopic.php?f=4&t=12507 CustomShields OXP]) to avoid blowing it up - and stop immediately when you see the Escape capsule. Then slowly touch the derelict ship to lock it to your towbar.

Reduce the pitch and yaw movements when towing. There is a small but increasing chance to break either the towbar or the towed ship: heavier ships break sooner. A few tips:
* Approach the derelict ship in the direction of your next movement, usually head to the Station to reduce turning with mass.
* Stop your ship before turning to cause less pressure to the towbar.
* Do not go on a sightseeing tour: the status of the ship degrades over time when moving, so you will earn more credits if you deliver it faster. You will be informed about flying parts to remember this. Such loss will be less at low speeds and your haul will be safe from this only if your ship is stopped!

Problems:
*If the towbar is destroyed then you can buy another and go back to the ship, just find the '''"D"''' (derelict) beaconCode on your [[Advanced_Space_Compass|Advanced Space Compass]]. [[Telescope]] OXP shows it also on your main scanner from any range.
*If you are too slow then either pirates will blow up the ship for the cargo, or hunters for the bounty or else some Thargoids will visit for sure!
*Other derelict ships in the system will not display a beaconCode on your ASC (due to the signal transmitter only being placed when the towbar is locked on).

Releasing the towed ship:
*You can release your towed ship if your ship touches another derelict ship.
*If you initiate a hyperjump then the towbar will release the towed ship. This means that you must sell the ship in the same system where you get it.
*You can also release the towed ship by priming your Towbar ('''Shift+N''') and pressing activate ('''n'''). The just released ship can then be relocked by another activate (within 200m).

Combat while towing:
*The towed ship is vulnerable, so you are recommended to avoid combat situations until it has been delivered.
*The largest towed ships face into your aft weapon - so you cannot fire it or you will destroy the towed ship! If you really ''must'' fire your rear laser, then release the ship by a double "h" keypress (start and stop a hyperjump) and pick it up again later. Before doing this you must have set a target system ''and'' have enough fuel for the jump.
*Do not engage in a fight while towing a ship (to avoid too much jerky movement which breaks the towbar). If you must, then, as above, release your towed ship and reclaim it after the battle.

Build up your reputation by salvaging more ships, (towing missions will require qualifications)!

Cost: 100.0₢
Techlevel: 1

==Laser Reductor==

This reduces your Laser power to minimal if your targeted enemy ship is derelict (to prevent you destroying it after the pilot has ejected).
You will get a "Derelict!" message with a "bloop" sound when your target is ejected to warn you to stop firing your laser.

Your first 10 hits will be reduced only, (''ie'' an entire second with a continuously firing beam laser). Most pilots are able to release the fire button within a second after warning sound started: if you fluff this then increase the $TowbarMaxReduct variable in towbar.js.

When you exceed this limit a "Laser Reductor disabled" message appears and you can now destroy your target to complete your mission.
You can turn off the reductor by priming (Shift-N) and activating (n) Towbar when there is neither a towed ship nor a derelict one within 200m.

It is recommended to install the "Derelict" display warning into your HUD (with either Detectors OXP, NumericHUDv3.11 or by following the instructions in the insertintohudlegends.plist file) to get another visual warning.

Cost: 100.0₢
Techlevel: 5

==Ship Miner==

Complex robots can transfer the valuable parts of the towed ship to your cargo hold - but this takes some time.

Mining operates in the following order:
:1. '''Cargo''': stronger ships tend to hold more valuable packages. Fuel is also transferred in this step.
:2. '''Computers''': from the built-in electronics, usually 1 or 2t depending on the ship size.
:3. '''Machinery''': from mining equipment and lasers, in equal value.
:4. '''Alloys''': from dismantling the hull into pieces - but only the smaller pieces can fit into the scoop (max. 10t).

Mining will stop by default when the cargo transfer is done - assuming you want to tow the ship into a station.

To continue mining the ship, prime Towbar ('''Shift+N''') and press mode ('''b'''): but this is suggested only if you do not plan to tow the ship back to any dock.
* Set back to the "'''Offline'''" or "Cargo only" settings if you plan to tow a ship again.
* The "'''Cargo only'''" mode is suggested due to possible loss of cargo from the towed ship while moving (which cannot happen from your cargo hold).
* The "'''Up to full'''" mode will mine until there is no free space left in your ship, the rest is left in the half-mined ship.
* The "'''Salvager'''" mode will drop out all mined inner parts into space to complete the mining operation and increase your salvager reputation regardless of whether your hold is full.

Cargo check needs some time (even for ships with 0t cargo) due to checking the cabin safe which can contain valuables.
Mining will be paused while steering, speed changing, injecting and torus travel - so it is best to mine when stopped or while travelling straight at a constant normal speed.

=== Parcels ===

Sometimes you can find parcels when finishing cargo transfer. Urgent ones need to be delivered to the main station within a few minutes.
Your ship's manifest screen (F5F5) will show the remaining time for delivery. Do not use autodock (Shift+C) due to it needing 20 minutes (regardless of the fact that it looks like an instant process!) - you will arrive too late.

Your parcel reputation will not suffer if you do not arrive in time due to you are not the one who undertook the delivery (expired parcels will be removed from your manifest screen to avoid such penalties).
Install [[Display_reputation_OXP|Display reputation OXP]] to track your progress: you will get more payout for the same work if you earn a higher reputation.

To find the shortest route for normal parcel delivery you should buy Advanced Navigational Array equipment, then select the galactic chart (F6F6), hold down "^" (Shift+6) and click on the destination (marked with a green diamond). Hold down the Ctrl key as well also to show the fastest route if that route takes too long. Press F1 and then "`" to review your time limit in your communications log in hours. The Manifest screen (F5F5) shows this in days but in the galactic chart (F6F6) you see the times of routes in hours.

=== Traps ===

Some ships are equipped with a self-destruct trap. A mistake during Fuel transfer can also end up with an explosion. These can cause major damage to your ship depending on the size of the towed ship. As you gain more and more salvaging experience you can prevent these problems more of the time. With [[ShipVersion]] OXP you usually can mine ships safely below or at your salvager level.

Towbar will not autolock if a trap can kill you due to the target being too large or your energy too low. You can override this safety feature by priming and activating Towbar but you risk dying in an explosion. There is always a small chance to fall into a trap, sometimes even an Elite Salvager can make mistakes also! It might be more prudent to avoid overriding this safety feature and wait until your energy and shields are recharged, buying Shield Boosters or even buying a larger ship with more energy banks.

Ship mining is not 100% safe, towed ships can explode from the meddling in rare cases which will surely also destroy the miner.

Finishing mining counts as 'salvaging the ship' which increases your reputation - so you can save the towing time by doing so if the money is less important to you.

The "'''Empty'''" word in the ship name means that the cargo has been transferred already, the "'''Mined'''" word means that mining is completed.
Your HUD can show these words also with [[Numeric_Style_HUDs|NumericHUD v3.11]] or by following the instructions in the insertintohudlegends.plist.
Derelict ships show as a light blue lollipop in the scanner when targeted, Empty ships show as blue and Mined ships show as dark blue.

If you want to sell the parts in another solar system then you must mine the ship before jumping (due to the impossibility of constructing a tool which can avoid the explosion of a badly damaged ship in hyperspace).

You should also complete mining if you are very far away from any dock to avoid losing many of the parts along the way. If the Station is nearby you will earn more credits by towing it as it is.

If you are mining a heavy ship which has more than 1.6 times the mass of your ship, then you are stuck and cannot move regardless of your speed settings. If you touch the controls while mining a heavy ship then you must release it immediately to avoid breaking the towbar.

Ship Miner can fit into large ships over 130t only and the mined parts need much cargo space, unless you found valuable cargo (Gold, Platinum or Gem-stones).

Cost: 20,000.0₢
Techlevel: 5

==Ship Miner Assistant==

Additional transporter bots can help to reduce the mining time and increase your safety.
The possibilities of losing or destroying ship parts are roughly halved.
These can also catch large parts when towing before they drop out of the towed ship.

Cost: 20,000.0₢
Techlevel: 11

==Towbar Compatible Injectors==

Allow the use of Injectors while towing a ship.
Costly due to the need of stronger towbar holders and of new exhaust fittings so that the towed ship is not damaged by exhaust emissions.

The towed ship loses more parts if the speed is higher - so you do not save money but you can save time.
Torus Drive is the only exception to the speed rule - so Torus is recommended for use as soon as possible.
Do not alter your direction while using these injectors otherwise your towbar will become much more unstable.

Cost: 20,000.0₢
Techlevel: 11

==Towbar Repair Bot==

Can fix a broken towbar, but once only.
Repair starts automatically when needed and takes about a minute.

The bot cannot repair a destroyed towbar - which happens almost as often as a broken one - so it is better to apply a Towbar Stabilizer, and use the repair bot as a last resort only.

Cost: 1,000.0₢.
Techlevel: 5

[[File:Equipment Icons.png|thumb|400px|right|'''Equipment Icons''' 
'''Towbar''' (2): Towbar Stabiliser, TugDrone 
(Deep Space Dredger (1): Salvage Missile) 
(Cargo Shepherd (1): Cargo Shepherd)]]
==Towbar Stabilizer==

Use this when your towbar is unstable - it will prevent damage and the possible explosion of your towed ship.
It occupies an empty pylon, and is launched as a mine.
Buy more than one if you plan to tow heavy ships for long distances.

It cannot fix a broken or destroyed towbar, nor resurrect a towed ship after an explosion caused by unstable towing: so use it before these problems occur.

Cost: 200.0₢
Techlevel: 5

==Tug Drone==

[[Image:Towbar10.png|400px|right]]
Launch as a 'fire and forget missile' at a derelict ship and you are done with the work!
Managed by the local authorities who charge a 50% commission but also pay up instantly when your tug drone hits the target.

The drone will eject the cargo and pay you for the ship only: so you must scoop the ejected cargo if you have not already extracted it with Ship Miner before launching your Tug Drone.
GalCop defends tug drones but the cargo ejection is due to the need for all pirates to know that tug drones never transport cargo (thus attaining a tolerable safety level where it is not worth the pirate's efforts to attack it).

[[Deep_Space_Dredger|Deep Space Dredger]] OXP provides a '''Salvage Missile''' which can autopilot a derelict ship with cargo.
In this case you must escort the derelict until it reaches a Dredger. This can be much harder due to pirate ambushes, but can also pay more due to avoidance of the local authorities' commission.

A Tug Drone can only fit into large ships (over 130TC).
Do not target small ships which pay less than the cost of the Tug Drone!
You must aim exactly at the target (''ie'' with a red [[STE]] box) to launch the drone, the regular green target lock is not exact enough.

The rotating ship model cannot be displayed in the sell salvage screen during flight, and your ship is moving while you read it so press enter shortly to reduce the blind fly time.

Cost: 1,000.0₢
Techlevel: 5

==Salvager License==

[[Image:Towbar9.png|400px|right]]
GalCop regulates ship salvaging at main stations; you must buy a license from your initial earnings, which is automatically deducted. You will only receive payments for the cargo after you have pooled the full 20,000 credits for the yearly license. You must buy a new license every year. Once you have a Salvager License, you must pay tax on the ship hull and equipment valuations based on the government type.

Government Tax
Anarchy 0 %
Feudal 5 %
Multi-Governmental 10 %
Dictatorship 15 %
Communist 20 %
Confederacy 25 %
Democracy 30 %
Corporate State 35 %

Non-GalCop stations do not require a license, but ''do'' charge a 50% commission. Dredgers in [[Deep_Space_Dredger|Deep Space Dredger]] OXP and Salvage Gangs in [[Anarchies_OXP|Anarchies]] OXP buy without commission due to processing the ship locally but they pay a low price for the alloys of the hull.

Cargo is never taxed or commissioned.

==Salvager Missions==

Your reputation is determined by how many ships you have salvaged either by delivery or by fully mining them.
When you reach certain levels of reputation you might embark on Salvager Missions (in v0.93 only the first of these is implemented):

Ships Rank Level Payout (₢) Need new Salvager License
0 First Aid Easy 1,000 No
2 Second Hand Easy 2,000 No
10 Ten Commands Easy 10,000 Yes
20 Twenty Sisters Medium 20,000 No
30 Thirty Pirates Medium 30,000 Yes
40 Forty Robbers Medium 40,000 Yes
50 Fifty Percent Hard 50,000 No
100 Hundred Tonnes Hard 100,000 Yes
200 200 Seconds Hard 200,000 No

==Salvager Rankings==

You can step up in your Salvager career by towing or mining derelict ships or achieving salvage missions.

As your reputation increases you can attain better rankings which are shown in your Manifest screen (F5-F5).

With higher ranks you can neutralize more complex traps in towed ships.

Ships Rankings
2 Novice Salvager
4 Assistant Salvager
8 Poor Salvager
16 Below Average Salvager
32 Average Salvager
64 Above Average Salvager
128 Competent Salvager
1000 Trustworthy Salvager!
3000 Infallible Salvager!
6000 Elite Salvager!

==Equipment Payout==
In v0.104, Towbar started supporting "pluggable" policies to calculate the value of the equipments, weapons included, in the salvaged ship, to be implemented by other OXPs.

The reason for that can be seen [http://bb.aegidian.org/viewtopic.php?p=270538#p270538 in this discussion].

In v0.104, those policies overwrite the standard policy - to change policies the player has to uninstall one policy OXP and install the other policy OXP, which requires exiting the game session. Payout OXPs compatible with the v0.104 version must have a single policy packaged inside.

After v0.105, Towbar supports in-game selection of the payout policy through the Station Interfaces (F4) ''Config for AddOns'' screen. Payout OXPs compatible with v0.105 could package more than one payout policy for the player to choose, but if an OXP packages more than one policy it is not compatible with Towbar v0.104.

The OXPs that package such alternative payout policies can be found [[Towbar_Payout|here]].

== Technical Information ==
Requires Oolite v1.77 and the [[BGS]] OXP if you want to see a nice background on the salvage screen.

=== Configuration ===
Towbar allows in-game configuration through Station Interfaces (F4) ''Config for AddOns'' for:

* TalkingShip: when true, Towbar will use Comms to send its messages to the player; otherwise the messages go to the Console.
* StartMode: start mode for Ship Miner: 0=Offline, 1=Cargo Only, 2=Full, 3=Salvager[.
* Appearance: the Towbar equipment appearance: 0=Retractable, 1=Fixed, 2=Tractor Beam.
* EqPayout: the salvaged equipment Payout Policy to use

Other configurations can only be altered by editingtowbar.js and re-starting the game:

* $TowbarDebug = false; //will spawn a derelict ship right after undock
* $TowbarLimit127t = false; //can limit markets to their original capacity (127t)
* $TowbarMaxReduct = 10; //how many hits will be reduced by the Laser Reductor on a derelict ship
* $TowbarNPCMissile = true; //NPCs with enhanced IQ: fire a missile before ejecting as a last resort
* $TowbarSlowTurn = true; //set to false if causing jerky controls while towing a ship

=== Payout OXPs ===

Payout OXPs add alternatives to the standard salvaged equipment payout policy. Such alternatives can be pro-player, paying more for the equipment, or anti-player, paying less.

A Payout Policy OXP MUST:

* create a function that takes an ''EquipmentInfo'' (which might contain a weapon) object as parameter and returns its salvage price IN CREDITS;
** if the ''scriptInfo'' property ''towbar_max_salvage_price'' is defined for an equipment, the value there MUST be the high limit for the payout returned by the function for that equipment;
* in the OXP's startUpComplete event handler:
** append a reference to that function to the array ''worldScripts.towbar.$TowbarEquipmentPayoutHandlers''; 
** define a property ''display'' for that function and assign a short and distinctive string to it - the first 6 characters will be used to identify the policy implemented by the function in the policy selection screen; 
** repeat for as many policies as wished (but bear in mind that all the policies short names will have to fit in a single line). 

=== License ===
*This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 3.0
*If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.
::Towbar applause sound source: http://soundbible.com/1260-Auditorium-Applause.html
::Towbar break sound source: bgs-c_hullbang.ogg in BGS OXP.
::Towbar fireworks sound source: http://soundbible.com/693-Fireworks-Finale.html
::Towbar hit derelict sound source: boop.ogg in Oolite.
::Towbar lock on sound source: bgs-m_fx_shipyard1.ogg in BGS OXP.

=== Changelog ===

2020.11.04. v1.0

* Just ups the version number to 1.0.

2020.11.03. v0.110

* Fixes bug in the verification of player ship's mass before offering the mission after towbar is bought.
* Towbar equipment salvage payout pricing looks at the equipment's scriptInfo property 'towbar_max_salvage_price' to limit the salvage price of equipments (useful for money-sinks like Shield Cycler Manual Configurator Standard and Advanced).

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">

2020.10.03. v0.109

* Towbar and Towbar Compatible Injectors have prices proportional to the ship's mass.
* Don't start the mission after the player buys towbar if the player's ship has less than 30t.
* Re-enables injectors after releasing the towed ship when hitch-riding a wormhole.
* Reduces the amount retained for the Salvager's License when salvaging at main station without a license from 100% to 60%.
* Uses $disableEquipemnt and $enableEquipment from Rapair Bots if available to disable/enable the injectors when towing without towbar compatible injectors.
* Stations with GalCop allegiance behave as main station.
* Player may choose to pay the full balance to the Salvager's License if enough credits are available.

2020.09.14. v0.108

* Deals with carried ships when salvaging a Carrier.

2020.09.04. v0.107

* Fixes bug that halted salvaging processing.
* Fixes bug that prevented Appearance parameter saved value from taking effect after loading from save file.
* More messages re-written to better English (thanks to Nite Owl).
2020.08.31. v0.106

* Fixes a bug in the fallback code for Laser Reductor.
* Doesn't blindly remove equipments defined by other OXPs.

2020.08.29. v0.105

* Fixes bug in cargo pod script that looks at the pod's cargo space instead of the player ship's when scooped.
* Implements salvaged equipment payout policy selection in-game through Stations Interfaces (F4) Config for AddOns.
* Laser Reductor looks at EquipmentInfo.weaponInfo.damage to know the energy of the hit to be reduced (uses a fallback for core game versions that don't allow scripts retrieval of weaponInfo).
* Creates TalkingShip, StartMode and Appearance parameters in Stations Interfaces (F4) Config for AddOns.
* Implements TalkingShip, with messages in better English thanks to Nite Owl.
* Removes the "Incoming Message" speech intro for Comms messages.

2020.08.10. v0.104

* Use commodity name instead of commodity display name as cargo identification in re-spawned cargo pods (with display name as identification, the cargo couldn't be put into the player's ship manifest when the cargo pod was scooped).
* Adjusted Laser Reductor to take into account the damage rate defined for the current weapon.
* Debug code to spawn derelicts just out the station when launching now spawn near the station where the player's ship is docked instead of the main station.
* Tweaked code the awards/remove EQ_DTADER to reduce the number of times it's added/removed while targeted.
* Upped minimal Oolite version to 1.81, removed code for older versions.
* Fixed bug that used commodity display name instead of name in lost-in-transit cargo pods.
* Fixed bug that removed rotation when reducing yaw and pitch while towing (affected ILS rotation-sync).
* Fixed bug in salvaged ship payout when the ship's cargo is beyond the local market capacity.
* Re-factored salvaged equipment pricing into a function (to make it easy to overwrite it with different pricing policies through other OXPs).
* Included port and starboard weapons (if any) in the salvaged ship payout.
* Reduced payout for salvaged ship's equipment and weapons.
* Some de-referencing for performance.

2020.06.23. v0.103

* Abort sound was not playing if the tug drone can't be launched.

2020.05.05. v0.102

* Better integration with Email System, preventing unnecessary emails being sent.

2020.02.23. v0.101

* Fixed two invalid reference errors in the towbar mission script.
* Some minor spelling/grammar corrections.

2016.08.14. v0.99

* Increased payout for equipments and weapons during ship salvaging.
* Towbar is not shown by default, just when tow a ship (retractable).
* Mission failed screen appear correctly at load game when must finish without rest.
* NPC will not fire missile at point-blank range before eject, thanks to Astrobe.
* Fixed multiplied parcels, thanks to Cmd Northgate.
* Removed "x. find" from parcel messages, suggested by Cmd Northgate.
* Fixed Constrictor hunt problem, thanks to Captain Obvious.
* First mission compatible with Escort Deck, thanks to Vincentz.
* Fixed for very long ships like Worker's Commuter in Commies OXP, thanks to TheOldGamer.
* Density of small-cargo1 raised to help scoop it with small ships, thanks to Bogatyr.
* Tug Drone got collision handler, thanks to Hullblazer.
* Ship Miner default mode changed to salvager as suggested by gt52

2015.03.15. v0.98

* Player get score if force a pilot to eject.
* Small fixes for Oolite 1.81 and without BGS.

2014.09.21. v0.97

* The first mission will fail if jump out from the system, thanks to Bogatyr.
* Cleanup after first mission: Moray removed, thanks to Falcon777.
* Trumbles modified to do not take over cargo, thanks to Falcon777.

2013.12.26. v0.96

* Bugfix in Tug Drone.
* Smaller large cargo box.

2013.12.14. v0.95

* Parcels and urgent parcels can be found during ship mining.
* Minor tweaks in mining and a bugfix with Trumbles.
* Audio and message warning if hit a derelict ship to stop fire in time.
* Laser Reductor limitation adjustable in $TowbarMaxReduct.
* Illegal cargo added into some ships with bounty.

2013.12.08. v0.94

* Laser Reductor fixed and can be turned off.

2013.10.23. v0.93

* Timed bomb implemented into some derelict ships.
* Traps are leveled up with [[ShipVersion]].
* Towbar will not autolock if a trap can be fatal.
* NPCs will stop attacking derelict ships.

2013.10.22. v0.92

* Trap ships and Fuel mining added (thanks to popsch).
* Injectors fixed when the towed ship destroyed by others.

2013.09.24. v0.91

* Give back Injectors after mission ship is delivered.
* Set $TowbarSlowTurn to false on computers where controls goes jerky when tow a ship.
* XML support in insertintohudlegends.plist.
* Effectdata.plist for Telescope OXP to show large cargo models.

2013.09.06. v0.9

* Laser Reductor, Ship Miner, Ship Miner Assistant and Tug Drone added.
* First Salvager Mission added.
* Towbar primeable to release and to change mining mode.
* Salvager Rankings displayed in F5-F5 screen (idea from Display reputation OXP).
* Deep Space Dredger and Salvage Gang buy ships without commission.
* Can lose or destroy alloys, cargo and equipments during towing and steering also.
* Flying out more t alloys and cargo in one large object instead of many 1t pieces.
* Flying equipments now scoopable as 1 or more t Machinery.
* The ship.script.$TowbarShipHealth is scalable from 0 to 1 (max. loss to no loss).
* Pitch rate less reduced with light towed ships.
* HUD can show the Derelict, Empty and Mined status of the current target.
* Pay bounty instantly when the target derelicted.
* Refund available for all equipments of this OXP.

2013.08.21. v0.8

* Chance to break the towbar or the towed ship (thanks to DaddyHoggy).
* Towbar break sound included, source: bgs-c_hullbang.ogg in BGS OXP.
* Towbar Stabilizer, Repair Bot and Towbar Compatible Injectors added.
* Towed ship get "D" (derelict) beaconCode.
* Build up reputation in missionVariables.
* Salvager License and tax system added.
* Flying alloys, cargo and equipments added.
* Ship moved to right in the sell salvage screen (thanks to Svengali and cim).

2013.08.18. v0.7

* Injectors offline and pitch rate very low when towing.
* Payment lowered.

2013.08.17. v0.6

* Lock on sound added. Source: bgs-m_fx_shipyard1.ogg in [[BGS]] OXP.
* Some ships carry much more valuable cargo than others.

2013.08.16. v0.5

* Give money for cargo also.

2013.08.15. v0.2

* Give money for equipments.

2013.08.14. v0.1

* First test files.
</div>
== Download ==

Download [[Media:Towbar-1.1.oxz|Towbar-1.1.oxz]].
*[[Media:Towbar-1.0.oxz|Towbar-1.0.oxz]].
*[[Media:Towbar-0.110.oxz|Towbar-0.110.oxz]].
*[[Media:Towbar-0.109.oxz|Towbar-0.109.oxz]].
*[[Media:Towbar-0.108.oxz|Towbar-0.108.oxz]].
*[[Media:Towbar-0.107.oxz|Towbar-0.107.oxz]].
*[[Media:Towbar-0.104.oxz|Towbar-0.106.oxz]].
*[[Media:Towbar-0.105.oxz|Towbar-0.105.oxz]].
*[[Media:Towbar-0.104.oxz|Towbar-0.104.oxz]].
*[[Media:Towbar_0.103.oxz|Towbar_0.103.oxz]].
*[[Media:Towbar_0.102.oxz|Towbar_0.102.oxz]].
*[[Media:Towbar_0.101.oxz|Towbar_0.101.oxz]].
*[[Media:Towbar_0.99.oxz|Towbar_0.99.oxz]].
*[[Media:Towbar_0.98.oxz|Towbar_0.98.oxz]] was downloaded {{#downloads:Towbar_0.98.oxz}} times.

== Links ==
*[http://www.aegidian.org/bb/viewtopic.php?f=2&t=2007 2006 discussion about towing derelicts]
*[http://www.aegidian.org/bb/viewtopic.php?f=2&t=4844 2008 Is destruction the only way?]
=== Other OXPs enhancing this one ===
*[[Deep Space Dredger]] - the dredger also plays a salvage role, and includes a Salvage missile
*[[BGS]] - for Towbar sounds
*[[Towbar Payout]] - there is currently only ''Medium'' available, but more are possible

== Quick Facts ==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Medium"|oxpMEM="Average"|oxpGPU="Low"|oxpIsParent=true|oxpIsChild=|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = Towbar
|version = 1.1
|release = 2022-10-25
|features = Introduces Salvaging.
|license = CC BY-NC-SA 4.0
|category = Activities OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=15204 BB-Link]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-violet.png]]

Towbar

2022-10-26T00:09:32Z

Dybal: /* Download */

Make money from derelict ships.
[[Image:Towbar1.png|600px|right]]
== Towbar ==

Pilots often eject when they have lost a fight and thus leave behind an almost destroyed ship.
You do not need to totally destroy these ships anymore for the bounty, because now you will get it instantly when the pilot ejects.

Your HUD can show the Derelict status of your target if either [[Detectors]] OXP or [[Numeric_Style_HUDs|NumericHUD v3.11]] OXP are installed or you insert the insertintohudlegends.plist file from the Towbar OXP into your hud.plist.

If you approach a derelict ship within 100m (or hurtle into it) with a low speed difference (below 10) then the towbar will lock it. You will see it in your aft view (F2).

''You can tow ships with a maximum of 1.6 times more mass than your ship''. Untowable ships can be mined with Ship Miner only (see below).

You cannot use Injectors unless you have special equipment and your pitch rate will be very low while towing (the $TowbarSlowTurn variable in towbar.js can be set to false on computers where controls go jerky while towing a ship).

Tow the ship into a dock in the current solar system to sell the hull as a large amount of alloys.

Ship Mass Alloys Approximated ₢
Adder 11 3 100
Moray 40 12 400
Cobra Mk I 47 14 500
Fer-de-Lance 51 15 500
Asp 59 18 600
Cobra Mk III 186 56 1800
Boa 192 58 1900
Python 222 67 2200
Anaconda 430 80 2600

[[Image:Towbar2.png|400px|right]]
The payment is calculated from the alloy price at the station where you sell it, plus 0-2TC Computers (depending on the ship size). The largest ships can give a maximum of only 80TC alloys due to their massive inner space. These alloys will not be added to the market because the ship is sold to a dealer who pays instantly but disassembles the wreck later (thus avoiding filling up the 127TC limit of the station's market). You will get several hundred credits for each saved piece of equipment, and for the weapons too. A [[Military_Laser|Military Laser]] will be worth 1-2 thousands (but probably the fight was harder to get it).

Cargo will be added to the market. All saved cargo is sold for the current price at the station. If the market is already filled with this cargo then the remains will be sold at half price (or discarded if you set $TowbarLimit127t to true in towbar.js).

Some ships (with high version numbers in [[ShipVersion]] OXP - so the more durable ones) hold much more valuable cargo than others.

[[Image:Towbar3.png|400px|right]]

With [[HardShips]] OXP you can get more equipment - as you can see in this image:

'''Compliments'''

You might get the following compliments:

* 1000₢: Nice work.
* 3000₢: Well done!
* 5000₢: Excellent!

'''Usage'''

Be careful when attacking a ship you hope to tow: slow your fire when the exhaust plume changes (or throwing sparks with [http://aegidian.org/bb/viewtopic.php?f=4&t=12507 CustomShields OXP]) to avoid blowing it up - and stop immediately when you see the Escape capsule. Then slowly touch the derelict ship to lock it to your towbar.

Reduce the pitch and yaw movements when towing. There is a small but increasing chance to break either the towbar or the towed ship: heavier ships break sooner. A few tips:
* Approach the derelict ship in the direction of your next movement, usually head to the Station to reduce turning with mass.
* Stop your ship before turning to cause less pressure to the towbar.
* Do not go on a sightseeing tour: the status of the ship degrades over time when moving, so you will earn more credits if you deliver it faster. You will be informed about flying parts to remember this. Such loss will be less at low speeds and your haul will be safe from this only if your ship is stopped!

Problems:
*If the towbar is destroyed then you can buy another and go back to the ship, just find the '''"D"''' (derelict) beaconCode on your [[Advanced_Space_Compass|Advanced Space Compass]]. [[Telescope]] OXP shows it also on your main scanner from any range.
*If you are too slow then either pirates will blow up the ship for the cargo, or hunters for the bounty or else some Thargoids will visit for sure!
*Other derelict ships in the system will not display a beaconCode on your ASC (due to the signal transmitter only being placed when the towbar is locked on).

Releasing the towed ship:
*You can release your towed ship if your ship touches another derelict ship.
*If you initiate a hyperjump then the towbar will release the towed ship. This means that you must sell the ship in the same system where you get it.
*You can also release the towed ship by priming your Towbar ('''Shift+N''') and pressing activate ('''n'''). The just released ship can then be relocked by another activate (within 200m).

Combat while towing:
*The towed ship is vulnerable, so you are recommended to avoid combat situations until it has been delivered.
*The largest towed ships face into your aft weapon - so you cannot fire it or you will destroy the towed ship! If you really ''must'' fire your rear laser, then release the ship by a double "h" keypress (start and stop a hyperjump) and pick it up again later. Before doing this you must have set a target system ''and'' have enough fuel for the jump.
*Do not engage in a fight while towing a ship (to avoid too much jerky movement which breaks the towbar). If you must, then, as above, release your towed ship and reclaim it after the battle.

Build up your reputation by salvaging more ships, (towing missions will require qualifications)!

Cost: 100.0₢
Techlevel: 1

==Laser Reductor==

This reduces your Laser power to minimal if your targeted enemy ship is derelict (to prevent you destroying it after the pilot has ejected).
You will get a "Derelict!" message with a "bloop" sound when your target is ejected to warn you to stop firing your laser.

Your first 10 hits will be reduced only, (''ie'' an entire second with a continuously firing beam laser). Most pilots are able to release the fire button within a second after warning sound started: if you fluff this then increase the $TowbarMaxReduct variable in towbar.js.

When you exceed this limit a "Laser Reductor disabled" message appears and you can now destroy your target to complete your mission.
You can turn off the reductor by priming (Shift-N) and activating (n) Towbar when there is neither a towed ship nor a derelict one within 200m.

It is recommended to install the "Derelict" display warning into your HUD (with either Detectors OXP, NumericHUDv3.11 or by following the instructions in the insertintohudlegends.plist file) to get another visual warning.

Cost: 100.0₢
Techlevel: 5

==Ship Miner==

Complex robots can transfer the valuable parts of the towed ship to your cargo hold - but this takes some time.

Mining operates in the following order:
:1. '''Cargo''': stronger ships tend to hold more valuable packages. Fuel is also transferred in this step.
:2. '''Computers''': from the built-in electronics, usually 1 or 2t depending on the ship size.
:3. '''Machinery''': from mining equipment and lasers, in equal value.
:4. '''Alloys''': from dismantling the hull into pieces - but only the smaller pieces can fit into the scoop (max. 10t).

Mining will stop by default when the cargo transfer is done - assuming you want to tow the ship into a station.

To continue mining the ship, prime Towbar ('''Shift+N''') and press mode ('''b'''): but this is suggested only if you do not plan to tow the ship back to any dock.
* Set back to the "'''Offline'''" or "Cargo only" settings if you plan to tow a ship again.
* The "'''Cargo only'''" mode is suggested due to possible loss of cargo from the towed ship while moving (which cannot happen from your cargo hold).
* The "'''Up to full'''" mode will mine until there is no free space left in your ship, the rest is left in the half-mined ship.
* The "'''Salvager'''" mode will drop out all mined inner parts into space to complete the mining operation and increase your salvager reputation regardless of whether your hold is full.

Cargo check needs some time (even for ships with 0t cargo) due to checking the cabin safe which can contain valuables.
Mining will be paused while steering, speed changing, injecting and torus travel - so it is best to mine when stopped or while travelling straight at a constant normal speed.

=== Parcels ===

Sometimes you can find parcels when finishing cargo transfer. Urgent ones need to be delivered to the main station within a few minutes.
Your ship's manifest screen (F5F5) will show the remaining time for delivery. Do not use autodock (Shift+C) due to it needing 20 minutes (regardless of the fact that it looks like an instant process!) - you will arrive too late.

Your parcel reputation will not suffer if you do not arrive in time due to you are not the one who undertook the delivery (expired parcels will be removed from your manifest screen to avoid such penalties).
Install [[Display_reputation_OXP|Display reputation OXP]] to track your progress: you will get more payout for the same work if you earn a higher reputation.

To find the shortest route for normal parcel delivery you should buy Advanced Navigational Array equipment, then select the galactic chart (F6F6), hold down "^" (Shift+6) and click on the destination (marked with a green diamond). Hold down the Ctrl key as well also to show the fastest route if that route takes too long. Press F1 and then "`" to review your time limit in your communications log in hours. The Manifest screen (F5F5) shows this in days but in the galactic chart (F6F6) you see the times of routes in hours.

=== Traps ===

Some ships are equipped with a self-destruct trap. A mistake during Fuel transfer can also end up with an explosion. These can cause major damage to your ship depending on the size of the towed ship. As you gain more and more salvaging experience you can prevent these problems more of the time. With [[ShipVersion]] OXP you usually can mine ships safely below or at your salvager level.

Towbar will not autolock if a trap can kill you due to the target being too large or your energy too low. You can override this safety feature by priming and activating Towbar but you risk dying in an explosion. There is always a small chance to fall into a trap, sometimes even an Elite Salvager can make mistakes also! It might be more prudent to avoid overriding this safety feature and wait until your energy and shields are recharged, buying Shield Boosters or even buying a larger ship with more energy banks.

Ship mining is not 100% safe, towed ships can explode from the meddling in rare cases which will surely also destroy the miner.

Finishing mining counts as 'salvaging the ship' which increases your reputation - so you can save the towing time by doing so if the money is less important to you.

The "'''Empty'''" word in the ship name means that the cargo has been transferred already, the "'''Mined'''" word means that mining is completed.
Your HUD can show these words also with [[Numeric_Style_HUDs|NumericHUD v3.11]] or by following the instructions in the insertintohudlegends.plist.
Derelict ships show as a light blue lollipop in the scanner when targeted, Empty ships show as blue and Mined ships show as dark blue.

If you want to sell the parts in another solar system then you must mine the ship before jumping (due to the impossibility of constructing a tool which can avoid the explosion of a badly damaged ship in hyperspace).

You should also complete mining if you are very far away from any dock to avoid losing many of the parts along the way. If the Station is nearby you will earn more credits by towing it as it is.

If you are mining a heavy ship which has more than 1.6 times the mass of your ship, then you are stuck and cannot move regardless of your speed settings. If you touch the controls while mining a heavy ship then you must release it immediately to avoid breaking the towbar.

Ship Miner can fit into large ships over 130t only and the mined parts need much cargo space, unless you found valuable cargo (Gold, Platinum or Gem-stones).

Cost: 20,000.0₢
Techlevel: 5

==Ship Miner Assistant==

Additional transporter bots can help to reduce the mining time and increase your safety.
The possibilities of losing or destroying ship parts are roughly halved.
These can also catch large parts when towing before they drop out of the towed ship.

Cost: 20,000.0₢
Techlevel: 11

==Towbar Compatible Injectors==

Allow the use of Injectors while towing a ship.
Costly due to the need of stronger towbar holders and of new exhaust fittings so that the towed ship is not damaged by exhaust emissions.

The towed ship loses more parts if the speed is higher - so you do not save money but you can save time.
Torus Drive is the only exception to the speed rule - so Torus is recommended for use as soon as possible.
Do not alter your direction while using these injectors otherwise your towbar will become much more unstable.

Cost: 20,000.0₢
Techlevel: 11

==Towbar Repair Bot==

Can fix a broken towbar, but once only.
Repair starts automatically when needed and takes about a minute.

The bot cannot repair a destroyed towbar - which happens almost as often as a broken one - so it is better to apply a Towbar Stabilizer, and use the repair bot as a last resort only.

Cost: 1,000.0₢.
Techlevel: 5

[[File:Equipment Icons.png|thumb|400px|right|'''Equipment Icons''' 
'''Towbar''' (2): Towbar Stabiliser, TugDrone 
(Deep Space Dredger (1): Salvage Missile) 
(Cargo Shepherd (1): Cargo Shepherd)]]
==Towbar Stabilizer==

Use this when your towbar is unstable - it will prevent damage and the possible explosion of your towed ship.
It occupies an empty pylon, and is launched as a mine.
Buy more than one if you plan to tow heavy ships for long distances.

It cannot fix a broken or destroyed towbar, nor resurrect a towed ship after an explosion caused by unstable towing: so use it before these problems occur.

Cost: 200.0₢
Techlevel: 5

==Tug Drone==

[[Image:Towbar10.png|400px|right]]
Launch as a 'fire and forget missile' at a derelict ship and you are done with the work!
Managed by the local authorities who charge a 50% commission but also pay up instantly when your tug drone hits the target.

The drone will eject the cargo and pay you for the ship only: so you must scoop the ejected cargo if you have not already extracted it with Ship Miner before launching your Tug Drone.
GalCop defends tug drones but the cargo ejection is due to the need for all pirates to know that tug drones never transport cargo (thus attaining a tolerable safety level where it is not worth the pirate's efforts to attack it).

[[Deep_Space_Dredger|Deep Space Dredger]] OXP provides a '''Salvage Missile''' which can autopilot a derelict ship with cargo.
In this case you must escort the derelict until it reaches a Dredger. This can be much harder due to pirate ambushes, but can also pay more due to avoidance of the local authorities' commission.

A Tug Drone can only fit into large ships (over 130TC).
Do not target small ships which pay less than the cost of the Tug Drone!
You must aim exactly at the target (''ie'' with a red [[STE]] box) to launch the drone, the regular green target lock is not exact enough.

The rotating ship model cannot be displayed in the sell salvage screen during flight, and your ship is moving while you read it so press enter shortly to reduce the blind fly time.

Cost: 1,000.0₢
Techlevel: 5

==Salvager License==

[[Image:Towbar9.png|400px|right]]
GalCop regulates ship salvaging at main stations; you must buy a license from your initial earnings, which is automatically deducted. You will only receive payments for the cargo after you have pooled the full 20,000 credits for the yearly license. You must buy a new license every year. Once you have a Salvager License, you must pay tax on the ship hull and equipment valuations based on the government type.

Government Tax
Anarchy 0 %
Feudal 5 %
Multi-Governmental 10 %
Dictatorship 15 %
Communist 20 %
Confederacy 25 %
Democracy 30 %
Corporate State 35 %

Non-GalCop stations do not require a license, but ''do'' charge a 50% commission. Dredgers in [[Deep_Space_Dredger|Deep Space Dredger]] OXP and Salvage Gangs in [[Anarchies_OXP|Anarchies]] OXP buy without commission due to processing the ship locally but they pay a low price for the alloys of the hull.

Cargo is never taxed or commissioned.

==Salvager Missions==

Your reputation is determined by how many ships you have salvaged either by delivery or by fully mining them.
When you reach certain levels of reputation you might embark on Salvager Missions (in v0.93 only the first of these is implemented):

Ships Rank Level Payout (₢) Need new Salvager License
0 First Aid Easy 1,000 No
2 Second Hand Easy 2,000 No
10 Ten Commands Easy 10,000 Yes
20 Twenty Sisters Medium 20,000 No
30 Thirty Pirates Medium 30,000 Yes
40 Forty Robbers Medium 40,000 Yes
50 Fifty Percent Hard 50,000 No
100 Hundred Tonnes Hard 100,000 Yes
200 200 Seconds Hard 200,000 No

==Salvager Rankings==

You can step up in your Salvager career by towing or mining derelict ships or achieving salvage missions.

As your reputation increases you can attain better rankings which are shown in your Manifest screen (F5-F5).

With higher ranks you can neutralize more complex traps in towed ships.

Ships Rankings
2 Novice Salvager
4 Assistant Salvager
8 Poor Salvager
16 Below Average Salvager
32 Average Salvager
64 Above Average Salvager
128 Competent Salvager
1000 Trustworthy Salvager!
3000 Infallible Salvager!
6000 Elite Salvager!

==Equipment Payout==
In v0.104, Towbar started supporting "pluggable" policies to calculate the value of the equipments, weapons included, in the salvaged ship, to be implemented by other OXPs.

The reason for that can be seen [http://bb.aegidian.org/viewtopic.php?p=270538#p270538 in this discussion].

In v0.104, those policies overwrite the standard policy - to change policies the player has to uninstall one policy OXP and install the other policy OXP, which requires exiting the game session. Payout OXPs compatible with the v0.104 version must have a single policy packaged inside.

After v0.105, Towbar supports in-game selection of the payout policy through the Station Interfaces (F4) ''Config for AddOns'' screen. Payout OXPs compatible with v0.105 could package more than one payout policy for the player to choose, but if an OXP packages more than one policy it is not compatible with Towbar v0.104.

The OXPs that package such alternative payout policies can be found [[Towbar_Payout|here]].

== Technical Information ==
Requires Oolite v1.77 and the [[BGS]] OXP if you want to see a nice background on the salvage screen.

=== Configuration ===
Towbar allows in-game configuration through Station Interfaces (F4) ''Config for AddOns'' for:

* TalkingShip: when true, Towbar will use Comms to send its messages to the player; otherwise the messages go to the Console.
* StartMode: start mode for Ship Miner: 0=Offline, 1=Cargo Only, 2=Full, 3=Salvager[.
* Appearance: the Towbar equipment appearance: 0=Retractable, 1=Fixed, 2=Tractor Beam.
* EqPayout: the salvaged equipment Payout Policy to use

Other configurations can only be altered by editingtowbar.js and re-starting the game:

* $TowbarDebug = false; //will spawn a derelict ship right after undock
* $TowbarLimit127t = false; //can limit markets to their original capacity (127t)
* $TowbarMaxReduct = 10; //how many hits will be reduced by the Laser Reductor on a derelict ship
* $TowbarNPCMissile = true; //NPCs with enhanced IQ: fire a missile before ejecting as a last resort
* $TowbarSlowTurn = true; //set to false if causing jerky controls while towing a ship

=== Payout OXPs ===

Payout OXPs add alternatives to the standard salvaged equipment payout policy. Such alternatives can be pro-player, paying more for the equipment, or anti-player, paying less.

A Payout Policy OXP MUST:

* create a function that takes an ''EquipmentInfo'' (which might contain a weapon) object as parameter and returns its salvage price IN CREDITS;
** if the ''scriptInfo'' property ''towbar_max_salvage_price'' is defined for an equipment, the value there MUST be the high limit for the payout returned by the function for that equipment;
* in the OXP's startUpComplete event handler:
** append a reference to that function to the array ''worldScripts.towbar.$TowbarEquipmentPayoutHandlers''; 
** define a property ''display'' for that function and assign a short and distinctive string to it - the first 6 characters will be used to identify the policy implemented by the function in the policy selection screen; 
** repeat for as many policies as wished (but bear in mind that all the policies short names will have to fit in a single line). 

=== License ===
*This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 3.0
*If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.
::Towbar applause sound source: http://soundbible.com/1260-Auditorium-Applause.html
::Towbar break sound source: bgs-c_hullbang.ogg in BGS OXP.
::Towbar fireworks sound source: http://soundbible.com/693-Fireworks-Finale.html
::Towbar hit derelict sound source: boop.ogg in Oolite.
::Towbar lock on sound source: bgs-m_fx_shipyard1.ogg in BGS OXP.

=== Changelog ===

2020.11.04. v1.0

* Just ups the version number to 1.0.

2020.11.03. v0.110

* Fixes bug in the verification of player ship's mass before offering the mission after towbar is bought.
* Towbar equipment salvage payout pricing looks at the equipment's scriptInfo property 'towbar_max_salvage_price' to limit the salvage price of equipments (useful for money-sinks like Shield Cycler Manual Configurator Standard and Advanced).

<div class="mw-collapsible mw-collapsed" data-expandtext="Show older" data-collapsetext="Hide older" style="overflow:auto;">

2020.10.03. v0.109

* Towbar and Towbar Compatible Injectors have prices proportional to the ship's mass.
* Don't start the mission after the player buys towbar if the player's ship has less than 30t.
* Re-enables injectors after releasing the towed ship when hitch-riding a wormhole.
* Reduces the amount retained for the Salvager's License when salvaging at main station without a license from 100% to 60%.
* Uses $disableEquipemnt and $enableEquipment from Rapair Bots if available to disable/enable the injectors when towing without towbar compatible injectors.
* Stations with GalCop allegiance behave as main station.
* Player may choose to pay the full balance to the Salvager's License if enough credits are available.

2020.09.14. v0.108

* Deals with carried ships when salvaging a Carrier.

2020.09.04. v0.107

* Fixes bug that halted salvaging processing.
* Fixes bug that prevented Appearance parameter saved value from taking effect after loading from save file.
* More messages re-written to better English (thanks to Nite Owl).
2020.08.31. v0.106

* Fixes a bug in the fallback code for Laser Reductor.
* Doesn't blindly remove equipments defined by other OXPs.

2020.08.29. v0.105

* Fixes bug in cargo pod script that looks at the pod's cargo space instead of the player ship's when scooped.
* Implements salvaged equipment payout policy selection in-game through Stations Interfaces (F4) Config for AddOns.
* Laser Reductor looks at EquipmentInfo.weaponInfo.damage to know the energy of the hit to be reduced (uses a fallback for core game versions that don't allow scripts retrieval of weaponInfo).
* Creates TalkingShip, StartMode and Appearance parameters in Stations Interfaces (F4) Config for AddOns.
* Implements TalkingShip, with messages in better English thanks to Nite Owl.
* Removes the "Incoming Message" speech intro for Comms messages.

2020.08.10. v0.104

* Use commodity name instead of commodity display name as cargo identification in re-spawned cargo pods (with display name as identification, the cargo couldn't be put into the player's ship manifest when the cargo pod was scooped).
* Adjusted Laser Reductor to take into account the damage rate defined for the current weapon.
* Debug code to spawn derelicts just out the station when launching now spawn near the station where the player's ship is docked instead of the main station.
* Tweaked code the awards/remove EQ_DTADER to reduce the number of times it's added/removed while targeted.
* Upped minimal Oolite version to 1.81, removed code for older versions.
* Fixed bug that used commodity display name instead of name in lost-in-transit cargo pods.
* Fixed bug that removed rotation when reducing yaw and pitch while towing (affected ILS rotation-sync).
* Fixed bug in salvaged ship payout when the ship's cargo is beyond the local market capacity.
* Re-factored salvaged equipment pricing into a function (to make it easy to overwrite it with different pricing policies through other OXPs).
* Included port and starboard weapons (if any) in the salvaged ship payout.
* Reduced payout for salvaged ship's equipment and weapons.
* Some de-referencing for performance.

2020.06.23. v0.103

* Abort sound was not playing if the tug drone can't be launched.

2020.05.05. v0.102

* Better integration with Email System, preventing unnecessary emails being sent.

2020.02.23. v0.101

* Fixed two invalid reference errors in the towbar mission script.
* Some minor spelling/grammar corrections.

2016.08.14. v0.99

* Increased payout for equipments and weapons during ship salvaging.
* Towbar is not shown by default, just when tow a ship (retractable).
* Mission failed screen appear correctly at load game when must finish without rest.
* NPC will not fire missile at point-blank range before eject, thanks to Astrobe.
* Fixed multiplied parcels, thanks to Cmd Northgate.
* Removed "x. find" from parcel messages, suggested by Cmd Northgate.
* Fixed Constrictor hunt problem, thanks to Captain Obvious.
* First mission compatible with Escort Deck, thanks to Vincentz.
* Fixed for very long ships like Worker's Commuter in Commies OXP, thanks to TheOldGamer.
* Density of small-cargo1 raised to help scoop it with small ships, thanks to Bogatyr.
* Tug Drone got collision handler, thanks to Hullblazer.
* Ship Miner default mode changed to salvager as suggested by gt52

2015.03.15. v0.98

* Player get score if force a pilot to eject.
* Small fixes for Oolite 1.81 and without BGS.

2014.09.21. v0.97

* The first mission will fail if jump out from the system, thanks to Bogatyr.
* Cleanup after first mission: Moray removed, thanks to Falcon777.
* Trumbles modified to do not take over cargo, thanks to Falcon777.

2013.12.26. v0.96

* Bugfix in Tug Drone.
* Smaller large cargo box.

2013.12.14. v0.95

* Parcels and urgent parcels can be found during ship mining.
* Minor tweaks in mining and a bugfix with Trumbles.
* Audio and message warning if hit a derelict ship to stop fire in time.
* Laser Reductor limitation adjustable in $TowbarMaxReduct.
* Illegal cargo added into some ships with bounty.

2013.12.08. v0.94

* Laser Reductor fixed and can be turned off.

2013.10.23. v0.93

* Timed bomb implemented into some derelict ships.
* Traps are leveled up with [[ShipVersion]].
* Towbar will not autolock if a trap can be fatal.
* NPCs will stop attacking derelict ships.

2013.10.22. v0.92

* Trap ships and Fuel mining added (thanks to popsch).
* Injectors fixed when the towed ship destroyed by others.

2013.09.24. v0.91

* Give back Injectors after mission ship is delivered.
* Set $TowbarSlowTurn to false on computers where controls goes jerky when tow a ship.
* XML support in insertintohudlegends.plist.
* Effectdata.plist for Telescope OXP to show large cargo models.

2013.09.06. v0.9

* Laser Reductor, Ship Miner, Ship Miner Assistant and Tug Drone added.
* First Salvager Mission added.
* Towbar primeable to release and to change mining mode.
* Salvager Rankings displayed in F5-F5 screen (idea from Display reputation OXP).
* Deep Space Dredger and Salvage Gang buy ships without commission.
* Can lose or destroy alloys, cargo and equipments during towing and steering also.
* Flying out more t alloys and cargo in one large object instead of many 1t pieces.
* Flying equipments now scoopable as 1 or more t Machinery.
* The ship.script.$TowbarShipHealth is scalable from 0 to 1 (max. loss to no loss).
* Pitch rate less reduced with light towed ships.
* HUD can show the Derelict, Empty and Mined status of the current target.
* Pay bounty instantly when the target derelicted.
* Refund available for all equipments of this OXP.

2013.08.21. v0.8

* Chance to break the towbar or the towed ship (thanks to DaddyHoggy).
* Towbar break sound included, source: bgs-c_hullbang.ogg in BGS OXP.
* Towbar Stabilizer, Repair Bot and Towbar Compatible Injectors added.
* Towed ship get "D" (derelict) beaconCode.
* Build up reputation in missionVariables.
* Salvager License and tax system added.
* Flying alloys, cargo and equipments added.
* Ship moved to right in the sell salvage screen (thanks to Svengali and cim).

2013.08.18. v0.7

* Injectors offline and pitch rate very low when towing.
* Payment lowered.

2013.08.17. v0.6

* Lock on sound added. Source: bgs-m_fx_shipyard1.ogg in [[BGS]] OXP.
* Some ships carry much more valuable cargo than others.

2013.08.16. v0.5

* Give money for cargo also.

2013.08.15. v0.2

* Give money for equipments.

2013.08.14. v0.1

* First test files.
</div>
== Download ==

Download [[Media:Towbar-1.1.oxz|Towbar-1.1.oxz]].
*[[Media:Towbar-1.0.oxz|Towbar-1.0.oxz]].
*[[Media:Towbar-0.110.oxz|Towbar-0.110.oxz]].
*[[Media:Towbar-0.109.oxz|Towbar-0.109.oxz]].
*[[Media:Towbar-0.108.oxz|Towbar-0.108.oxz]].
*[[Media:Towbar-0.107.oxz|Towbar-0.107.oxz]].
*[[Media:Towbar-0.104.oxz|Towbar-0.106.oxz]].
*[[Media:Towbar-0.105.oxz|Towbar-0.105.oxz]].
*[[Media:Towbar-0.104.oxz|Towbar-0.104.oxz]].
*[[Media:Towbar_0.103.oxz|Towbar_0.103.oxz]].
*[[Media:Towbar_0.102.oxz|Towbar_0.102.oxz]].
*[[Media:Towbar_0.101.oxz|Towbar_0.101.oxz]].
*[[Media:Towbar_0.99.oxz|Towbar_0.99.oxz]].
*[[Media:Towbar_0.98.oxz|Towbar_0.98.oxz]] was downloaded {{#downloads:Towbar_0.98.oxz}} times.

== Links ==
*[http://www.aegidian.org/bb/viewtopic.php?f=2&t=2007 2006 discussion about towing derelicts]
*[http://www.aegidian.org/bb/viewtopic.php?f=2&t=4844 2008 Is destruction the only way?]
=== Other OXPs enhancing this one ===
*[[Deep Space Dredger]] - the dredger also plays a salvage role, and includes a Salvage missile
*[[BGS]] - for Towbar sounds
*[[Towbar Payout]] - there is currently only ''Medium'' available, but more are possible

== Quick Facts ==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Medium"|oxpMEM="Average"|oxpGPU="Low"|oxpIsParent=true|oxpIsChild=|oxpIsAPI=true|oxpIsDocumented=true|oxpIsConfigurable=true}}
[[Image:IconLib.png|48px|right|link=Library OXP|alt=Config options available through 'Library']]
{{Infobox OXPb| title = Towbar
|version = 1.0
|release = 2020-11-04
|features = Introduces Salvaging.
|license = CC BY-NC-SA 4.0
|category = Activities OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=15204 BB-Link]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-violet.png]]

File:Towbar-1.1.oxz

2022-10-26T00:07:55Z

Dybal: Version 1.1

== Summary ==
Version 1.1

ILS

2022-10-25T14:52:56Z

Dybal: /* Changelog */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS (though the commander can switch ILS off by unlocking the station). The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the (non-required) clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ship targeting something else which comes into its sight (beware of Telescope!) during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents (hopefully :-) ) docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs (to avoid them plastering themselves on the station back
or side walls...).
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane (avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:51:55Z

Dybal: /* Changelog */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS (though the commander can switch ILS off by unlocking the station). The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the (non-required) clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ship targeting something else which comes into its sight (beware of Telescope!) during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents (hopefully :-) ) docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs (to avoid them plastering themselves on the station back
or side walls...).
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:50:55Z

Dybal: /* Changelog */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS (though the commander can switch ILS off by unlocking the station). The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the (non-required) clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ship targeting something else which comes into its sight (beware of Telescope!) during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents (hopefully :-) ) docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:50:28Z

Dybal: /* Warning */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS (though the commander can switch ILS off by unlocking the station). The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the (non-required) clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ship targeting something else which comes into its sight (beware of Telescope!) during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:47:30Z

Dybal: /* Description */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS (though the commander can switch ILS off by unlocking the station). The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the (non-required) clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:44:49Z

Dybal: /* Description */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS (though the commander can switch ILS off by unlocking the station). The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:43:22Z

Dybal: /* Description */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station) - if you can see the dock entrance, your are in the right place, if not you have to move to a place you can see the dock before ILS will engage
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T14:41:34Z

Dybal: /* Description */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not required
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T00:24:49Z

Dybal: /* Quick Facts */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not necessary
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.15
|release = 2022-10-24
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T00:24:31Z

Dybal: /* Download */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not necessary
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.15.oxz‎|ILS-1.15.oxz‎]] (downloaded {{#downloads:ils-1.15.oxz‎}} times).

Old versions:

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.14
|release = 2022-08-08
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-10-25T00:23:50Z

Dybal: /* Changelog */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not necessary
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===

2022.10.24. v1.15 Prevents docking upside-down when rotation is necessary.
Do not use ILS to dock on Salvage Gangs (it does not work well with its deeply
recessed dock).
Extends the "ship must be in the outside side of the docking bay entrance for ILS
to engage" rule to NPCs.
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock
entrance's plane avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

Old versions:

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] ([[User:Slartibartfast|Slartibartfast]], 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.14
|release = 2022-08-08
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

File:Ils-1.15.oxz

2022-10-25T00:20:02Z

Dybal: Version 1.15

== Summary ==
Version 1.15

Save In Flight OXP

2022-09-19T00:44:42Z

Dybal:

[[File:Save-and-Jump OXP.png|right|500px]]
==Overview==
'''Save In Flight''' allow the player to save the game in mid-flight, ''i.e.'' while not docked at a station.

This is done through a new piece of equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to a stop, and then prime and activate the Save In Flight equipment.

The player ship will then be "teleported" to the Station at the End of the Universe, where the game can be saved (or reloaded).

To come back from the Station at the End of the Universe, the player should just launch and the player's ship will be moved to the last place where the Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.1.oxz|Save In Flight v1.0.1]].

Old versions:

[[Media:SaveInFlight-1.0.0.oxz|Save In Flight v1.0.0]].

== Acknowledgments ==

*This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 discussion in the forum]
*[[Save and Jump OXP]] (2012)

==Version History==

v1.0.1 (sep/2022):
* Restore original Fuel Leak Rate after launch (Battle Damage OXP migth cause a fuel leak upon launch if the hull was damaged before saving;
*Restore TC use for scooped marshallable commodities (those in g and kg) after launch (the core game marshalled them at launch) - thanks to Massively Locked for the heads up and code;

v1.0.0 (sep/2022):
* Initial version

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Save In Flight
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]
[[Category:Equipment]]

Save In Flight OXP

2022-09-19T00:41:52Z

Dybal: /* Download */

[[File:Save-and-Jump OXP.png|right|500px]]
==Overview==
'''Save In Flight''' allow the player to save the game in mid-flight, ''i.e.'' while not docked at a station.

This is done through a new piece of equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to a stop, and then prime and activate the Save In Flight equipment.

The player ship will then be "teleported" to the Station at the End of the Universe, where the game can be saved (or reloaded).

To come back from the Station at the End of the Universe, the player should just launch and the player's ship will be moved to the last place where the Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.1.oxz|Save In Flight v1.0.1]].

Old versions:

[[Media:SaveInFlight-1.0.0.oxz|Save In Flight v1.0.0]].

== Acknowledgments ==

*This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 discussion in the forum]
*[[Save and Jump OXP]] (2012)

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Save In Flight
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]
[[Category:Equipment]]

File:SaveInFlight-1.0.1.oxz

2022-09-19T00:40:33Z

Dybal: version 1.0.1

== Summary ==
version 1.0.1

Save In Flight OXP

2022-09-08T15:53:19Z

Dybal: /* Overview */

[[File:Save-and-Jump OXP.png|right|500px]]
==Overview==
'''Save In Flight''' allow the player to save the game in mid-flight, ''i.e.'' while not docked at a station.

This is done through a new piece of equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to a stop, and then prime and activate the Save In Flight equipment.

The player ship will then be "teleported" to the Station at the End of the Universe, where the game can be saved (or reloaded).

To come back from the Station at the End of the Universe, the player should just launch and the player's ship will be moved to the last place where the Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.0.oxz|Save In Flight v1.0.0]].

== Acknowledgments ==

*This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 discussion in the forum]
*[[Save and Jump OXP]] (2012)

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Save In Flight
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]
[[Category:Equipment]]

Save In Flight OXP

2022-09-08T15:52:44Z

Dybal: /* Overview */

[[File:Save-and-Jump OXP.png|right|500px]]
==Overview==
'''Save In Flight''' allow the player to save the game in mid-flight, ''i.e.'' while not docked at a station.

This is done through a new piece of equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to a stop, and then prime and activate the Save In Flight equipment.

The player ship will be then teleported to the Station at the End of the Universe, where the game can be saved (or reloaded).

To come back from the Station at the End of the Universe, the player should just launch and the player's ship will be moved to the last place where the Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.0.oxz|Save In Flight v1.0.0]].

== Acknowledgments ==

*This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 discussion in the forum]
*[[Save and Jump OXP]] (2012)

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Save In Flight
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]
[[Category:Equipment]]

Save In Flight OXP

2022-09-06T12:49:16Z

Dybal: /* Download */

==Overview==
Save In Flight allow the player to save the game in mid-flight, i.e., while not docked at a station.

That's done through a new equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to repose, then prime and activate the Save In Flight equipment.

The player shop will be then teleported to the Station at the End of Universe, where the game can be saved (or reloaded).

To come back from the Station at the End ofo Universe, the player should just launch and the palyer's ship will be moved to the last plaec where Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.0.oxz|Save In Flight v1.0.0]].

== Aknowledgments ==

This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 discussion in the forum]

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Barrel Roll
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]

Save In Flight OXP

2022-09-06T12:47:46Z

Dybal: /* Aknowledgments */

==Overview==
Save In Flight allow the player to save the game in mid-flight, i.e., while not docked at a station.

That's done through a new equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to repose, then prime and activate the Save In Flight equipment.

The player shop will be then teleported to the Station at the End of Universe, where the game can be saved (or reloaded).

To come back from the Station at the End ofo Universe, the player should just launch and the palyer's ship will be moved to the last plaec where Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.0|Save In Flight v1.0.0]].

== Aknowledgments ==

This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 discussion in the forum]

==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Barrel Roll
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]

Save In Flight OXP

2022-09-06T12:47:17Z

Dybal: Created page with "==Overview== Save In Flight allow the player to save the game in mid-flight, i.e., while not docked at a station. That's done through a new equipment, Save in Flight, availab..."

==Overview==
Save In Flight allow the player to save the game in mid-flight, i.e., while not docked at a station.

That's done through a new equipment, Save in Flight, available at Ship Outfitting at Tech Level 1 and above for 0.1 credits.

To save while not docked, the player must move away from other entities until the scanner is empty (it wouldn't do to let any Ooniverse habitant see those extra-dimensional entities coming and going!), bring the ship to repose, then prime and activate the Save In Flight equipment.

The player shop will be then teleported to the Station at the End of Universe, where the game can be saved (or reloaded).

To come back from the Station at the End ofo Universe, the player should just launch and the palyer's ship will be moved to the last plaec where Save In Flight equipment was activated.

==Details==

*Tech Level - 1.
*Cost - 0.1 credits.

==Download==

Download [[Media:SaveInFlight-1.0.0|Save In Flight v1.0.0]].

== Aknowledgments ==

This OXP is based on suggestions by cim in a [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 | discussion in the forum]
==Quick Facts==
{{OXPLevel|0}}
{{IconOXP|ooVersion="1.81"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"}}

{{Infobox OXPb| title = Barrel Roll
|version = 1.0.0
|release = 2022-09-06
|features = Allows saving the game in-flight.
|license = CC BY-NC-SA 4.0
|category = Miscellaneous OXPs
|author = [[User:dybal|Dybal]]
|download = [[#Download|See Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=2&t=21293 BB-Link]
}}

==Gameplay and Balance indicator==
[[Image:tag-colour-blue.png]]

[[Category:Oolite expansion packs]]

File:SaveInFlight-1.0.0.oxz

2022-09-06T12:28:52Z

Dybal: Version 1.0.0

== Summary ==
Version 1.0.0

Sun Gear

2022-08-19T16:59:25Z

Dybal: /* Sun properties */

[[File:Sun Data.png|thumb|right|Advanced System Data MFD: Sun data 
Solar wind flux currently reads as 0 due to occlusion from the nearby planet's magnetosphere]]
== Overview ==
This OXP aims to make the suns in the solar systems more realistic. It also implements dynamic solar flares - and also a solar wind model allowing refueling with fuel scoops in space reasonably close to the sun (without needing to skim the sun)!

Current OXZ - Version 4.4.0
Uploaded 06 July 2020

== History of Development ==
This project was initially inspired by Distant Suns (author Wildblood). The main reason to develop this alternative project was the rebalancing of the sun population and using the potential of more complex color spaces instead simple named colors for a more accurate simulation of solar spectra.

Another similar project is Distant Stars (author Rustem). It was presented later and had no such influence on my work with one exception (discussed later).

Let’s omit the long story of iterations such as “hot yellow suns for agricultural systems, red and orange dwarves for industrial ones” and outline the present state of project.

== Sun population and spectra ==

If you’ll inspect star population in Sun proximity (quite common region of Galaxy in terms of star population) and apply statistical data to Ooniverse, typical distribution of suns on regional map will be approximately:
*5...10 hot white stars (spectral class A) – like Sirius
*10...15 yellow stars (spectral class G) – like our Sun or Alpha Centauri A or bit cooler like Tau Ceti
*25 orange dwarves (spectral class K) – like Epsilon Eridani or 61 Cygni
*200 red dwarves (spectral class M) – like Proxima Centauri

And the rest of total 256 systems – 15...25 of brown dwarves (“failed” stars with mass too low to maintain ignition of thermonuclear synthesis in core).
This is reality. Most of Galaxy star population belongs to low mass, relatively cold, dim red dwarves with extremely long life span.
Well, now take statistical data for distribution of stars with confirmed exoplanets. This is rapidly expanding database and data for March 2015 are outdated, but tendency as whole remains actual. For Oolite 256 system map approximately:
*A + B – 4 systems
*F – 36 systems
*G – 128 systems
*K – 72 systems
*M – 16 systems

Observation bias, of course. Searching exoplanets is shifted to suns like our Sun because Sun twins seems most suitable suns for habitable planets. But is seems for the same reasons that distribution of colonized worlds will be shifted to suns like our Sun too.

Distribution of suns in Distant Suns reflects predominance of red dwarves in Galaxy:
*B – 4 systems
*A – 12 systems
*F – 16 systems
*G – 32 systems
*K – 64 systems
*M – 128 systems

Six spectral classes and seven named colors: blue, cyan, white, yellow, orange, red, magenta (red and magenta are both used for M class red dwarves).

Distant Stars uses more complex RGB color space and has potential to simulate wide range of spectral subclasses, but there are only six spectral subclasses in database:
*A2 – 7 systems
*A7 – 21 system
*F2 – 40 systems
*G2 – 118 systems
*K2 – 30 systems
*K8 – 40 systems

Red dwarves are completely excluded from Rustem’s Ooniverse and remaining suns reflects above mentioned distribution of stars with exoplanets.

Sun Gear covers only four spectral classes, not six as in Distant Suns, but every spectral class is subdivided into spectral subclasses with unique color signatures. Spectral class G (yellow stars) for example is subdivided onto subclasses from G0 to G9. Moreover, every subclass is subdivided onto two steps with unique color too. Spectral subclass G2 for example is subdivided onto two steps – G2 and G2.5. This nomenclature is sometimes used in astronomy for more precise classification (star of spectral class G2.5 is a bit cooler than G2 but a bit hotter than G3). In total 28 spectral subclasses and 56 unique spectral signatures from F6 to M3. All suns in Sun Gear belongs to main sequence (luminosity class V), so you can see sun designations as G2V or K7V.
Distribution of suns in Sun Gear is shifted to yellow suns of spectral class G – not for reasons based on real astronomy data, but for considerations of visual pleasure. Wildeblood’s Ooniverse with predominance of red suns seems a bit too biased to red. Nice for space battles, but I prefer more frequent yellow and white for illumination of planet textures. Color distribution of sun population for Sun Gear 4.3 for all eight sectors (total 2048 systems):
*F6V...F9V (white stars) – 214
*G0V...G9V (yellow stars) – 1102
*K0V...K9V (orange dwarves) – 433
*M0V...M3V (red dwarves) – 299

Hot B and A stars with bluish-white tint are completely excluded from my Ooniverse. It seems that life span of F5V star or hotter is too limited for planets with multicellular life and advanced biomes. Red dwarves cooler than M5V is another case: these suns has extremely long life span, but extremely violent solar flares too.

Since Sun Gear 4.0 I'm using RGB color space for sun colors instead HSB. In theory RGB colors based on real astrometric data can be simulated, but there are technical limitations in game, preventing such accurate simulation. Color of sun in Oolite is blended with 50% white, so you have no possibility to get saturated color. Moreover, real color space in Oolite is too restricted to simulate colors of real stars. M0V red dwarf, for example, has RGB color #ffcd90 or 255, 205, 144 in decimal notation, but you have no possibility to get value below 170 in any channel. Overriding this limitation needs some skill in redefining blending rules. So sun colors in Sun Gear enhanced to provide more visual diversity to game world.

== Sun properties ==

Sun mass and chemical composition are initial parameters in theory of star evolution. Having sun mass and chemical composition you’ll predict sun radius and temperature. Having sun radius and temperature you’ll calculate sun luminosity. Having sun luminosity you’ll calculate inner and outer radius of sun habitable zone. And having radius of main planet orbit in centre of habitable zone you’ll calculate main planet orbital period (local year). This is how matters stand in theoretical astrophysics and celestial mechanics.

In astronomy we usually know star magnitude and color. Well, star color and temperature are strongly correlated parameters (black body radiation approximation), so knowing star color you’ll know star temperature. For nearest stars you’ll also have distance measured directly with some error margins. Based on magnitude and distance you’ll calculate star luminosity. Based on star luminosity and temperature you’ll calculate star radius. In case of nearest binary stars with measurable orbital periods like Alpha Centauri you can estimate masses of components. In case of distant star you have only directly measured star magnitude and color, maybe sometimes distance with more wide error margins. You can estimate missing parameters based on known mean properties of stars of the same spectral class. This is how matters stand in real astronomy.

And this is how matters stand in Ooniverse: we have only sun radius in planetinfo.plist, not sun mass nor temperature per se. But we can estimate missing parameters based on known properties of stars of the same radius.

Just for historical reasons I am not using Sun analog as standard candle, but sun of spectral class G0V (temperature 6000 K).

*If you have sun with radius 0.96 of standard candle – this is our Sun twin: spectral class G2V, temperature 5800 K, luminosity 0.80, mean radius of habitable zone 0.90.
*If you have sun with radius 0.8 of standard candle – this is orange dwarf: spectral class K0V, temperature 5000 K, luminosity 0.31, mean radius of habitable zone 0.56.
*If you have sun with radius 0.6 of standard candle – this is red dwarf: spectral class M0V, temperature 4000 K, luminosity 0.07, mean radius of habitable zone 0.27.
And so on.

This is simplified and slightly shifted data – you’ll see in astronomy handbooks temperature of M0V red dwarf color 3750 K, not 4000 K, and temperature of K0V orange dwarf 5240 K, not 5000 K. Sun Gear is not intended for generating publications in Astrophysical Journal. :-)
*Radius of standard candle is 1,000,000 m in game units. So sun radii covers range from 460,000 m (M3.5V red dwarf) to 1,120,000 m (F6 white star). Sun analog (G2V) has radius 960,000 m in game units (radius of our Sun in real reality is 696,000 km).
*Sun radii, temperatures and masses distribution is pseudo-randomly smoothed to avoid discrete gaps in data. Every sun has unique radius, temperature and mass.

== Sun distances and habitable zones ==

Sun Gear large suns (5x of vanilla suns) needs really vast solar systems, of course. In vanilla Ooniverse distance between Earth twin (radius approx. 6400 km) is 64,000 * 20 = 1,280,000 m in game units. In Sun Gear distance between Earth and Sun twins is approx. 43,500,000 m – 34 times farther (approx. 680 planet radii).

Distances between system sun and main planet are set to provide standard insolation level (the same insolation that Earth receives from Sun) with pseudo-random distance bias ± 5%, so Sun Gear simulates real proportions of habitable zones. M0V red dwarf has luminosity only 0.09 of our Sun, so in such system distance between sun and main planet will be approx. 0.3 of distance between Sun and Earth twins – approx. 12,900,000 m in game units. Based on mass of red dwarf 0.55 solar mass and main planet orbit radius 0.3 AU in accordance with Third Kepler’s Law we’ll have main planet orbital period approx. 81 days, and Sun Gear really calculates local year for main planet of every visited system.

== Large planets – large suns ==

Search for logically motivated sun population distribution was maybe most informal part of project, and after experimenting I came to simple rule:
''Sun radius is proportional to main planet radius''.

Seems too oversimplified – we have evidence of numerous super-Earths, discovered in systems of red dwarves. Sometimes there are more than one planet similar with Earth in terms of mass and radius in systems of red dwarves, like in TRAPPIST-1. Observation bias again maybe – combination of large and massive planet(s) with low mass red dwarf is optimal for planet detection. But definitely there are no any reasons to prevent formation of large planets in system of red dwarves and vice versa, small planets in systems of yellow and white suns.

This project was started in epoch of Oolite 1.77, when sun_distance_modifier – parameter, measured in planet radius – was the only way to construct custom solar systems. Correlation between planet radius and sun radius is simplest way to generate population of systems with main planets near habitable zone – having large planet, you have large sun too, but more distant. All my systems has sun_distance_modifier in range from 450 to 700.
Since Oolite 1.81 we have direct parameter sun_distance and above mentioned reason is obsolete. Sun Gear now using sun_distance parameter. But there are some reasons to maintain this rule “large planet – large sun”.

First, we have nav charts with large and small colored circles. Having large planets associated with large suns we have also cool sky chart with really looking color-coded stars! Just aesthetic reason, of course. But aesthetics is a vital component of good game.
Second, function planet radius vs sun radius is a good reason to limit spectral class range to above mentioned values. Look, if your Earth twin (6400 km for simplicity) has sun with radius 960,000 km (15 planet radii in game units), small planet with radius 2800 km will have sun 420,000 km. This is M3V red dwarf in my scale. Again, planet radius 6900 km gives sun radius 1,035,000 km – this is F8V white star. Pure coincidence, honestly, but such fortunately!
Third reason will be discussed a bit later.

Just one remark. I have another OXP – [[Habitable Main Planets]] (HMP). It redefines vanilla planet radii to more realistic values. Details are in relevant topic. Sun radii in Sun Gear are correlated with planet radii redefined in HMP, not in vanilla ones. It is not the case if you are using Sun Gear as pure ambience, but without HMP part of vanilla planet population vill be outside of habitable zones. So since Sun Gear 4.3 I decided to declare HMP as obligatory condition for Sun Gear.

== A little more about habitable zones ==

Sun Gear calculates equilibrium temperature of main planet, providing this information for my other OXPs. '''System Makeup OXP''', for example, uses this calculated main planet temperature to select planet texture. In the previous Sun Gear iterations I was using simple formula for such calculation, with no account taken of greenhouse effect. To generate various climate conditions I was using rule “large planets in systems of hot suns a bit closer to inner edge of habitable zone, small planets in systems of cold red dwarves – a bit closer to outer edge” in combination with pseudo-random distance offsets. Now Sun Gear taking greenhouse effect into account. Just rough formula, of course, based on estimation of atmosphere mass as function of planet radius. So large main planets in systems of white and yellow stars has more warm climate as compared with small main planets in systems of orange and red dwarves not due to more hot sun ''per se'' but due to more dense atmospheres providing more evident greenhouse effect.

== Solar flares and solar wind ==

Rustem’s Distant Stars has nice custom feature – dynamic solar flares. I borrowed this idea for Sun Gear (with my own realization of course).

Corona flare is controlled dynamically by script. Most of time sun of system is in quiet state (corona_flare random value in range 0.1…0.2), but sometimes solar flares occurs and corona_flare rises randomly up to 0.5 (yes, I know, in reality it is NOT linear correlation between solar corona size and solar flares!). As a rule flare frequency increases from yellow to red stars. Peculiar suns with "solar activity" in system description has more frequent flares with higher magnitudes (corona_flare rises up to 1.0 in case of "deadly solar activity").

Solar wind model is implemented. Solar wind allows to refuel ship without sunskimming (in some cases refuelling is possible en route from witchpoint to main planet). More detailed description of this feature will be found in the [[Hard Way]] OXP.

Magnetospheres of celestial bodies are simulated. Solar wind density is dropped to zero level near planets and moons.

== AstroLibrary ==

AstroLibrary is a library, providing astronomic (oostronomic may be?) functions to calculate sun spectrum, main planet temperature (used in System Makeup OXP to set planet texture), main planet orbital period & planet and moon parameters (used in Planetary Systems OXP), solar wind density (used in Hard Way OXP to collect fuel) etc.

== Advanced System Data MFD ==

Advanced System Data MFD provides custom system info on two pages.
[[File:Planetary System Data.png|thumb|right|Advanced System Data MFD: Planetary system data]]
=== Sun Data info page ===

Sun catalog number (galaxy sector and system ID)
Sun spectral class
Sun radius
Sun mass
Sun luminosity
Solar activity
Main planet period in days
Sun distance
[[Solar Wind Flux|Solar wind flux]]: important for [[Hard Way]]

=== Planetary System Data info page ===
This provides list of additional planets in solar system. It displays only planet orbit radii in OU and planet class:

Dwarf terra - planet like Pluto or Ceres
Miniterra - planet like Mercury
Subterra - planet like Mars
Terra - planet like Earth or Venus
Superterra - planet like ... hmm, we have no such example in our Solar System. Gliese 667 Cc maybe?
Ice giant - planet like Uranus or Neptune
Gas giant - planet like Jupiter or Saturn

=== "Planet Data" / "Lunar Data" Interface ===
These data interfaces are only seen on landing and are generated by other oxp's in this suite. They are not MFDs and are accessed through the F4 screen.

== Dependencies ==
*[[Habitable Main Planets]] as mentioned above.

== Credits ==

*Wildblood - Distant Suns OXP/OXZ: initial concept of custom sun population & spectroscope script.
*Tch - Tch_Russian_Systems OXP: idea of using RGB model for sun color instead simple named colors.
*Rustem - Distant Stars OXP/OXZ: idea of dynamic coronae.
*Damocles Edge, phkb and another_commander - detecting OXP incompatibility with DH ANC OXP, formulation issue with HSB colors and invaluable help to solve this issue.

== Links ==
*Bulletin Board [http://www.aegidian.org/bb/viewtopic.php?f=4&t=19973 discussion]
*[[Strangers World]]

[[Image:tag-colour-green.png]]

{{Ambience-OXP}}
[[Category:Stranger's World]]

Planetary Systems

2022-08-19T16:48:00Z

Dybal: /* PlanetEngine */

'''Core package'''

*Current OXZ version 1.7.0
*Uploaded 06 July 2020

'''Planetary System Texture Pack A...Z'''

*Current OXZ version 1.6.0
*Uploaded 23 November 2020

This project was started as a tweaked version of [[Orbits]]. Good old Orbits (authors Ebi and [[User:Kaks‎|Kaks‎]]) had textured planets and improved compatibility with large moons. Planetary Systems is a major modification of the original Orbits - but the original Orbits script, realizing the generation of the solar system and its orbital dynamics, remains as a crucial component of Planetary Systems. So let’s start our presentation from Orbits' script modifications.

== System layout and orbital mechanics ==

The maximum additional number of planets in a system has been raised from 7 to 8.

Like the original [[Orbits]], this script generates a planet subset, selecting planets from the planetinfo.plist on pseudo-random basis: but technically there are 10 variants for every planet class in the planetinfo.plist. Mini-terra, for example, are presented with radii of 2750, 2775, 2800, and 2975 km. The script preudo-randomly selects one from ten variants for every planet class in the generated subset. Ten radius variants for every planet class is not just for visual diversity (it is hard to notice visual difference between 3400 and 3600 km radius without a specially planned experiment!). The main reason is provide more diversity for the initial data, used by PlanetEngine (about PlanetEngine a bit later)

These planets are divided onto classes based on radius:
*Miniterra – Mercury analog
*Venus-like planet or desert Terra-like planet
*Subterra – Mars-like planet
*Superterra aka Super-Earth
*Two gas giants like Jupiter or Saturn without rings
*Ice giant – Neptune analog
*Dwarf terra – Pluto analog

It seems to be similar to our Solar system layout with exception of super-earth, but really '''Orbits''' generates wide range of possible layouts. You can see systems with only gas giants except main planet or with only terrestrial planets.

Discriminating borderline between large moon and small planet is raised from 1000 to 2500 km (from 10,000 to 25,000 m in game units). So you can simulate large moons such as Titan or Ganymede.

Original '''Orbits''' has fixed orbital period of main planet 300 days (standard year of canonic Lave). Modified script uses orbital period of main planet calculated on base of sun mass and distance (this part of work is provided by AstroLibrary external function in [[Sun Gear]]). So you’ll have not only unique planet layout for every system, you’ll have unique value of local year.

Like the original '''Orbits''', '''Planetary Systems''' generates more compact systems than our real Solar system. [[Tionisla]] for example has almost all our planets except the Neptune analog, but with the following arrangement:
*0.63 OU – Miniterra
*1.00 OU – Main planet
*2.20 OU – Terra
*3.04 OU – Subterra
*3.79 OU – Superterra
*4.77 OU – Gas Giant
*5.94 OU – Gas Giant
*6.67 OU – Dwarf Terra

The '''Planetary Systems''' script, inherited from '''Orbits''', limits possible layouts. You’ll never have two planets between sun and main planet as in our Solar system, only one is possible. You’ll never have second planet close enough to the habitable zone so you’ll never generate a lovely sci-fi setting with two or more habitable planets in the system. And you’ll never generate systems expanding beyond 9 OU or so. 

'''Planetary Systems''' like the original '''Orbits''' is not intended for simulation of elongated elliptical orbits, high inclination orbits, orbital resonances ''etc''. All planets orbit in the same plane without any dynamic interaction. An extremely simplified model like that of a school astronomy handbook, of course. 

It is possible to realize a technically more complex model by upgrading the code, but some crucial parts of the original code are too hard for me to clearly understand and to modify without risk of breaking it. So I focused on more obvious tasks.

== PlanetEngine ==

Planet mass and chemical composition are two initial parameters, determining planet appearance. For moons and terrestrial planets you have such building materials as water ice (density 0.9), rock (density approx 2.5) and iron-nickel alloy (density approx 8.0). So for planets and moons composed mainly from these materials you’ll have mean density between these extreme values. In inner region of Solar system where solar irradiation is enough to sublimate volatiles you have mostly mix of rock and metal with only few volatiles and mean density of terrestrial planets are between 3.940 for Mars and 5.515 for Earth. In outer region of Solar system beyond frost line all three building materials are present so moons of gas and ice giants composed mainly from mix of water ice, rock and metal and mean density is from 0.98 (Tethys, composed mainly from water ice) to 3.53 (extremely dehydrated due to volcanic activity Io).
There are also more exotic materials such as dry ice (solid carbon dioxide), nitrogen ice, water-ammonia brine, high pressure water ice modifications etc. But as rule of thumb: more distance from sun – less insolation – lower equilibrium temperature – less sublimation effects – more volatiles – lower mean density. 

Situation with planet mass is more complex. Mean density of terrestrial planet depends not only from its bulk composition. More massive planet with same composition will be more dense due to gravitational compression. From a different standpoint, more massive planet in the same region of space can capture more volatiles, thus reducing mean density.

Having sufficient mass, planets can effectively capture hydrogen and helium from primordial nebula, so super-earth with critical mass above 10 Earth mass will develop extremely massive atmosphere and will transform onto ice giant or gas giant. Difference between ice giants like Uranus and Neptune and gas giants as Jupiter and Saturn lies mainly in their inner composition, not in their visual appearance. Uranus for example consists mainly from water, ammonia and methane ices (approx 9.3...13.5 Earth masses) and rocky core (0.5...3.7 Earth masses). Hydrogen and helium in Uranus atmosphere are only 0.5...1.5 Earth mass. Jupiter, for contrast, contains relatively small core – 12...45 Earth mass. Most of Jupiter’s 318 Earth mass consists from metallic, liquid and gaseous forms of hydrogen. 

This is real astronomy. In Oolite we have no planet masses nor planet density simulated, so PlanetEngine deals with some retro-engineering: taking planet radius and planet density (calculated as function of insolation and radius) it calculates planet mass. There are really three functions for planet density in PlanetEngine: for terrestrial planet, for ice giants and for gas giants (in case of ice and gas planets located deeply outside frost line insolation is not taken into account, just planet radius). Having planet mass and radius, calculations of surface gravity and escape velocity are trivial tasks.
Just one note. PlanetEngine uses planet with 6400 km radius as Earth analog for simplicity, not 6371 km real Earth mean radius (6378 km, mentioned in '''Sun Gear''' topic, is Earth equatorial radius), so calculated surface gravity and escape velocity will be slightly different from real values based on precise calculations using gravitational constant G. 

Atmosphere parameters are less formalized data on project. Look on our Solar system. Extremely thin and cold Mars atmosphere (6 mbar pressure on “sea level”) is a present result of dissipation of more dense initial atmosphere. Extremely dense and hot Venus atmosphere (93 bar and 735 K on surface level) is a result of limestone degassing caused by runaway greenhouse effect. Extremely oxygen enriched Earth atmosphere (21% oxygen) is result of activity of life on planet. We have no (yet!) exact knowledge of initial atmosphere parameters for these planets nor accurate general model of atmosphere evolution during 4.6 billions years from formation of Solar System. So this part of PlanetEngine is a bit wild and, honestly, oversimplified speculation based on some assumptions. 

PlanetEngine calculates atmosphere mass per unit of surface square based on initial atmosphere pool (more planet mass and less insolation – more fraction of volatiles) and rate of dissipation (again more planet mass and less insolation – more atmosphere remains). Atmosphere pressure is calculated as weight of atmosphere mass per surface unit (you can calculate it having only atmosphere mass per surface unit and surface gravity). 

Atmosphere temperature calculation is not so simple. Greenhouse effect is roughly calculated based on atmosphere mass per surface unit. Final temperature on surface level is a sum of equilibrium temperature of planet surface without atmosphere and greenhouse offset. This is oversimplified model, not taking into account planet albedo nor atmosphere composition. But it simulates diversity of conditions, generating planets with extremely rarefied cold atmosphere like Mars, dense cold atmospheres like Titan or superdense extremely hot atmosphere like Venus.

=== Planet Data Interface ===
That’s enough about the details of PlanetEngine's internal functions. How it will it be manifested in game? 
If you have [[PlanetFall]] OXP (author [[User:Thargoid|Thargoid]]) or my '''PlanetLand''' (OXP with similar functionality, based on PlanetFall) installed, after docking with planet/moon surface port you’ll have access to new F4 screen Planet Data interface. It generates pages with slightly different output for planets and moons.
[[File:SW Planet Data Sheet.png|thumb|right|Accessed through the F4 page on landing]]
==== Planet Data Sheet for planet ports ====
*ORBITAL DATA
*Orbit radius in OU
*Orbit period in days
*PHYSICAL DATA
*Radius, km
*Mean density, g/cm^3
*Mass, TU – Terran Units
*Escape velocity, km/s
*Surface gravity, g
*Atmosphere pressure, bar
*Surface temperature, K

Output for the '''Moon Data Sheet''' is almost the same, but orbit radius is displayed in host planet radius units, not in OU.

There are two tricks in the case of super-earths, ice giants and gas giants.

Gas giants have no surface in common sense. Gas deeply below cloud layers smoothly reaches state of supercritical fluid. So Planet Data Sheet page takes 1 bar atmosphere pressure level as reference point in case of gas and ice giants.

Non-linear scale is implemented to large planets (super-earths, ice and gas giants). Being only 172,500 m radius in game really, largest gas giant is displayed in Planet Data Sheet page as gas giant of 72,500 km radius instead 17,250 km of default planet scale. Planet mass, escape velocity and surface gravity is displayed scaled too. This non-linear scale is used for display purposes only. Any calculation are based on internal scale. This is forced decision. Honest simulation of planet with 72,500 km radius (slightly more than Jupiter’s 71,500 km equatorial radius) will create too wide zone of mass-lock. Starting from surface port on Cobra Mk III, you’ll need 34.5 min on full throttle to leave mass-lock zone. Honest displaying of real 17,250 km radius of Jupiter analog will lead to too low mass of planet: having density 1.325 like real Jupiter its analog will have only 4.7 mass in Earth units, not real 318!

There is also bias in small planet parameters. Mercury and Pluto analogs in Planetary Systems are larger than prototypes. Initially it was implemented as simple way to avoid confusion between small planets and large moons.

There are two parameters, extremely important for a good sci-fi setting and completely missing in the PlanetEngine so far.

=== Planet axial rotation period (local day) ===
Typical value of rotation_speed parameter in planetinfo.plist included in game is between 0 and 0.005 radians/s. Having a rotation_speed of 0.0045 and a radius of 4116 km (the case of the vanilla Lave), you’ll have a rotation period only 23 min 16 s and linear rotation velocity on an equator of 18.5 km/s! Such a planet in reality will be ripped asunder by the centrifugal forces. Of course, this is a setting just for visual appearance. It seems a nice idea to give player opportunity to observe almost all the planet during the short trip from the witchpoint to the main station. But if you have '''PlanetFall''' and descend to low altitude, things seem to be wrong – the planet rotation looks too fast comparing with ship speed.

Setting rotation_speed to honest value 0.0001 or so (rotation period 17 hours 45 mins) will solve this problem, but at the cost of visual appearances – it is problematic to note subtle changes in planet details visibility during few minutes of flight. I have no idea how best to solve this conflict.

=== Planet axis tilt ===
This parameter is crucial for climate modeling. But in Oolite planet orientation seems to work unpredictably – despite the same orientation declared for all additional planets in planetinfo.plist some of them are almost upright, some are lying on their sides. I have no idea how to fix it. Honestly.

== Smart selection of planet texture ==

Initially '''Planetary Systems''' has a predetermined set of textures for every planet class such as a Martian texture set for analogs of Mars, Venusian for analogs of Venus and so on. A Mercury analog orbit is always created between the sun and the orbit of the main planet, so it is safe to give Mercury analog texture of heavy cratered dry world such real Mercury or Moon. Terra-like planet in absence of Mercury analog will be be inside main planet orbit and looks like Venus, but if Mercury analog is present, Terra-like planet will be placed outside main planet orbit and looks like snowball Earth. Pluto analog is extreme case: in rare events of absence of other additional planets it occupies place of Mercury and looks like dry hot airless world, not icy cold airless one. These variations were implemented in next iteration of [b]Planetary Systems[/b].

Now textures for terrestrial planets selected using not planet positions per se but surface temperature and atmosphere pressure, calculated by PlanetEngine. So we have more possible variants in planet appearance: it may looks like Mars with polar ice caps or without ones, like cold windy rocky desert or hot sandy desert, like snowball Earth or volcanic world. I hope it will be fun to explore these variations.

There are five variants of every type of texture (60 in sum), selected for every system pseudo-randomly.

== Dependencies ==

This OXP uses AstroLibrary functions in '''Sun Gear''' OXP to calculate properties of system planets and moons. So [[Sun Gear]] OXP is obligatory.
[[Habitable Main Planets]] OXP is highly recommended to provide more reliable data for main planet. This is no way to match calculated atmosphere density and surface temperature for planet of 3000 km radius, for example, with vanilla game classification of such world as agricultural/tropical paradise. :-)

== Known issues ==

*Interaction of '''Planetary Systems''' with planets added by other OXPs can cause inflation of system far beyond planned size. '''Diso.oxp''' with 4 additional planets is a good example of such a system.
*'''Planetary Systems''' is incompatible with '''Additional Planets SR''' due to the same reason.
*Like the original '''Orbits''', '''Planetary Systems''' needs some time to generate a solar system, so problems with the positioning of moons, stations and ships added by third party OXPs or system populators can appear. See more details discussed in my [http://aegidian.org/bb/viewtopic.php?f=4&t=8216 post] from Dec 23, 2018

* A specific case of incompatibility is the '''Market Cooldown''' OXZ (author [[User:Spara|Spara]]). It uses the sum of station distances to the witchpoint and the sun as a unique key for port identification. This method works in static deterministic system, but fails in dynamic systems with a changing psw triangle.
*'''Planetary Systems''' in combination with [[Sun Gear]] generates really vast solar systems. Having a planet with radius 6400 km and the sun at a distance of 695 planet radii, planets on the outer 7.5 OU edge of the system will be at a distance of 333,600,000 m in game units – slightly less than distance between Earth and Moon in reality. This takes 8 hours 16 minutes for a Cobra Mk III to fly on a Torus drive, so you need special instruments for the exploration of such distant planets such as Norby’s [[Torus To Sun]] or my own ''warp drive,'' implemented in [[Hard Way]]. Navigation in such vast systems is almost impossible without the ASC ([[Advanced Space Compass]]) upgrade. These considerations, however, are implemented only for intra-system navigation: the distance between the main planet and the witchpoint remains unaffected, and so therefore so does inter-system navigation.

== OXP structure ==

To provide easy updating all planet textures have been repacked as separate texture packs. 
*Planetary Systems.oxp - core package.
*Planetary Systems Texture Pack A.oxp - Ice Deserts
*Planetary Systems Texture Pack B.oxp - Cold Deserts
*Planetary Systems Texture Pack C.oxp - Sand Deserts
*Planetary Systems Texture Pack D.oxp - Volcanic Deserts
*Planetary Systems Texture Pack E.oxp - Cold Mars Analogs
*Planetary Systems Texture Pack F.oxp - Hot Mars Analogs
*Planetary Systems Texture Pack G.oxp - Gas and Ice Giants
*Planetary Systems Texture Pack H.oxp - Miscellaneous (Mercury, Pluto, Venus analogs and super-earths).

The original planet textures were reprocessed. Reprocessing included converting the JPG file format into PNG, rescaling the image size to standard aspect for lat-long maps 2:1 with size 2 * 2^n width and 2^n height, using color saturation and lights/shadows level correction filters. 
Texture size 4096x2048 was used as a compromise between file size and visual quality, but due to the shortage of high-res texture files, medium-res 2048x1024 textures were also used to complete the texture sets.

== Credits ==

*Orbits main script - Ebi, Kaks.
*Textures - Celestia Motherlode and freebitmaps.blogspot.com.
*See more detailed texture credits in Texture Pack Readme documents.

== Links ==
*[http://aegidian.org/bb/viewtopic.php?f=4&t=20016 BB Discussion Thread]
*[[Strangers World]]

[[Image:tag-colour-green.png]]

{{Ambience-OXP}}
[[Category:Stranger's World]]

Repair Bots OXP

2022-08-17T23:27:59Z

Dybal: /* Quick Facts */

[[File:Srs.png|thumb|right|250px|[[Vimana HUD]] icon for SRS Repair NanoBots]]
[[File:Missile, ECM hardened missile, Quirium Cascade Mine, Repair Bots, Salvage Missile.png|thumb|right|250px|missile bay icons: Missile, ECM-hardened missile, Quirium cascade bomb, '''Repair nanobots''', Salvage missile]]
==Overview==
As any commander on the go knows, there is nothing more frustrating than having valuable and necessary equipment getting broken in-flight, usually just before you really need it. So the researchers at the [[Aquarian Shipbuilding Corp. HQ|Aquarian Shipbuilding Corporation]]'s ships equipment division have taken the repair nanobots used on a large scale for station repairs, and adapted them for standard ship usage.

It also now provides a second piece of equipment - the fully mountable repair system. This is true ship's damage control, available to any ship that doesn't already have it built-in. It uses advanced repair bots to control and repair any broken equipment that happens on the ship in-flight.

==Usage==
As standard, the repair 'bots are packaged in a small container which is specially designed to keep them dormant until their services are required. Due to Galcop rules this container is not allowed to be stored within the vessel itself, so the standard solution is to mount it on an empty missile pylon, with the added bonus that the standard missile arming and launching sequence can be used to activate and release the 'bots.

When activated the 'bots perform a scan of the vessels systems, and by comparing what they find with their in-build blueprints they can identify which (if any) system or systems are damaged. From this they will select which item they want to repair (this is limited to a single item as a further Galcop mandated safety measure to prevent runaway replication) and proceed to attempt work on it.

Please note that whilst these useful little creatures won't stop to take coffee breaks or chat-up the pilot's girlfriend, they are only as reliable as their in-built blueprints. So for more complicated systems and for some variant items sold by various companies, there is a chance that they will not be able to fully repair all items before their mandatory limited lifespan expires. In this case the usage of an additional cannister or two of 'bots may assist with the problem.

Now featuring a lovely new pylon icon for the bots, courtesy of Eldon.

STOP-PRESS! - following some heavy lobbying by the transport haulers oonion, Galcop have relaxed their rules about storage of the nanobots. So the ASC are now very proud to announce the introduction of their patent Repair System. Built into the workings and systems of the customer ship, it automatically attempts to repair any broken equipment using its own supply of bots. No missile pylons have to be sacrificed to the gods of fixing stuff, but consumes one energy unit per second while effecting repairs, going dormant if there is only one energy bank available and re-starting when the ship has to two full energy banks again.

There are two versions available: the standard one occupies 2t of cargo space and holds nanobots to effect up to ten repairs, and a light version that occupies 1t of cargo sapce and holds nanobots for 5 repairs. The recharge packs of nanobots come in two sizes, a 10-pack for up to ten repairs and a 5-pack for up to 5 repairs.

Repair System Standard:
Cost: 12000 Cr.
Techlevel: 11 
Repair System Light:
Cost: 10000 Cr.
Techlevel: 12 
Repair System Recharge, 10-Pack:
Cost: 1000 Cr.
TechLevel: 9 
Repair System Recharge, 5-Pack:
Cost: 600 Cr.
Techlevel: 9 
Repair Nanobots (pylon mounted):
Cost: 3000 Cr.
Techlevel: 9

==Requirements==
This OXP requires at least test version 1.74 of Oolite.

==Download==

[[Media:RepairBots-2.14.oxz|RepairBots_2.14.oxz]] (downloaded {{#downloads:RepairBots-2.14.oxz}} times).

Old versions:

[[Media:RepairBots-2.13.oxz|RepairBots_2.13.oxz]] (downloaded {{#downloads:RepairBots-2.13.oxz}} times).

[[Media:RepairBots-2.12.oxz|RepairBots_2.12.oxz]] (downloaded {{#downloads:RepairBots-2.12.oxz}} times).

[[Media:RepairBots-2.11.oxz|RepairBots_2.11.oxz]] (downloaded {{#downloads:RepairBots-2.11.oxz}} times).

[[Media:RepairBots_2.10.oxz|RepairBots_2.10.oxz]] (downloaded {{#downloads:RepairBots_2.10.oxz}} times).

==Tweaks==
*[http://aegidian.org/bb/viewtopic.php?p=253573#p253573 Souping-up the Repair-bots] (2017)
*You might find [[How to tweak OXZ's]] helpful!

==Notes for OXP developers==
The new and improved repair bots have a chance to repair anything installed on the ship. Any OXP writer who wishes to alter this for their own OXP simply needs to add the line:

script_info = { thargoidRepairBotChance = X; };

into their equipmentInfo.plist file entry for the equipment in question - replacing X with the numerical value between 0 (never repaired) and 1 (always repaired). If no such entry is made the repair chance will be based on the equipment's tech level.

Other OXPs can also temporarily inhibit Repair Bots from repairing an equipment through the use of the disabling/enabling equipment functions described bellow.

;<code>worldScripts["Repair System"].$disableEquipment(eqKey, who, why)</code>
:<code>eqkey</code>: string, equipment key
:<code>who</code>: string, identifies the caller
:<code>why</code>: string, describes the reason why the equipment is disabled

:Sets the equipment as DAMAGED and inserts it in the disabled equipment list (equipment in th disabled list is not repaired)

;<code>worldScripts["Repair System"].$enableEquipment(eqKey, who)</code>
:<code>eqkey</code>: string, equipment key
:<code>who</code>: string, identifies the caller

:Removes the caller from the disablers of the equipment and if there is no disabler left, sets the equipmenty status to OK

==Version History==

17/08/2022 - Version 2.14
*Changes the to remove the "Thargoid clauses" after Thargoid allowed modification when retired from maintaining his OXPs (http://aegidian.org/bb/viewtopic.php?f=4&t=17085).
*Fixes typo that prevented resuming operation after a low energy period (thanks to cag and UK_Eliter!).

04/10/2020 - Version 2.13
*Energy thresholds are now proportional to the ship's maxEnergy and not absolute: repair stops when energry drops to 20% and resumes when it reaches 40%.
*Self-repair, i.e., repairing the Repair System Controller, consumes 2 charges.
*ew functions for other OXPs tell Repair Systems that an equipment is disabled, i.e., it's damaged but should not be repaired. This allows OXPs to inhibit Repair Systems actions on a given equipment during a period of time, while the probabilities in the scriptInfo are "hard-coded", i.e., can't be changed by scripts.

14/09/2020 - Version 2.12
*checks for repair controller existence before starting the repair system.

24/08/2020 - Version 2.11
*introduced '''Repair System Light''', with 5 charges taking 1 TC of cargo space, and Recharge 5-Pack.
*introduced energy cost while repairing, with minimum of one energy bank to work. (Dybal)

xx/xx/2012 - Version 2.10
*requirement now for 1.77. Restored the 2t space requirement.
*also added an 0.5s delay to activation on damage, to allow other scripts to run first (OXP equipment self-repair and also realistic damage OXP).

07/08/2012 - Version 2.09
*temporary removal of requirement for 2t cargo due to bug in 1.76.1 (rollback of v2.06 in part).

23/07/2012 - Version 2.08
*small bugfix to cope better with selling of ships and persistence of mission variables.

03/06/2012 - Version 2.07
*removing minor glitch so remaining charges only show on F5 manifest screen when the Repair System is actually installed - thanks to JazHaz for the heads-up.

09/05/2012 - Version 2.06
*made repair system require 2t of cargo space ready for v1.77 implementation.
*also will only work for 10 repairs before needing a recharge.

19/03/2012 - Version 2.05
*corrected error in script - thanks to Cmdr Cheyd.

03/11/2011 - Version 2.04
*further optimisation by Eric Walch.

02/11/2011 - Version 2.03
*script speed hack courtesy of Capt. Murphy.

02/04/2011 - Version 2.02
*superb new pylon icon for the repair bot cannister, by Eldon.

13/02/2011 - Version 2.01
*removal of upper limit, to allow running with 1.75.

17/05/2010 - Version 2.00
*update for v1.74 (only) - now uses script to scan players equipment, so can fix anything not explicitly in the exclusion list.
*also new addition of the repair system.

02/09/2009 - Version 1.10
*ditto for v1.73.

10/11/2008 - Version 1.00
*script update for v1.72 compatability.

25/09/2008 - Version 0.99
*pre-release version with some OXP equipment support (more to follow). Inclusion of chance of failure for more complex equipment (above equipment tech level 8) and lowering of price to 3000 credits.

05/09/2008 - Version 0.10
*beta test release.

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.79"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title = Repair Bots
|version = 2.14
|release = 2022-08-17
|features = self-repair
|license = CC BY-NC-SA 3
|category = Equipment OXPs
|author = [[User:Thargoid|Thargoid]]
|download = [[Media:RepairBots-2.11.oxz|Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=20722& BB-Link]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-violet.png]]

==Links==
* [[User:Thargoid|Thargoid's OXP page]].
* [http://aegidian.org/bb/viewtopic.php?f=4&t=20722 BB Thread] (2020)
* [http://aegidian.org/bb/viewtopic.php?f=4&t=18033 BB Thread] (2016)
* [http://aegidian.org/bb/viewtopic.php?f=4&t=5034 BB Thread] (2008)

*[http://bb.aegidian.org/viewtopic.php?f=4&t=13592 External Repair System for subentities]. GGShinobi (2013) Alpha release. (for [[Imperial Courier (Oolite)|rotating nacelles]], [[Z GrOovy HPC pack|landing gear]], ''etc''!)
{{equipment-OXP}}

[[Category:Oolite_expansion_packs]]

Repair Bots OXP

2022-08-17T23:27:31Z

Dybal: /* Version History */

[[File:Srs.png|thumb|right|250px|[[Vimana HUD]] icon for SRS Repair NanoBots]]
[[File:Missile, ECM hardened missile, Quirium Cascade Mine, Repair Bots, Salvage Missile.png|thumb|right|250px|missile bay icons: Missile, ECM-hardened missile, Quirium cascade bomb, '''Repair nanobots''', Salvage missile]]
==Overview==
As any commander on the go knows, there is nothing more frustrating than having valuable and necessary equipment getting broken in-flight, usually just before you really need it. So the researchers at the [[Aquarian Shipbuilding Corp. HQ|Aquarian Shipbuilding Corporation]]'s ships equipment division have taken the repair nanobots used on a large scale for station repairs, and adapted them for standard ship usage.

It also now provides a second piece of equipment - the fully mountable repair system. This is true ship's damage control, available to any ship that doesn't already have it built-in. It uses advanced repair bots to control and repair any broken equipment that happens on the ship in-flight.

==Usage==
As standard, the repair 'bots are packaged in a small container which is specially designed to keep them dormant until their services are required. Due to Galcop rules this container is not allowed to be stored within the vessel itself, so the standard solution is to mount it on an empty missile pylon, with the added bonus that the standard missile arming and launching sequence can be used to activate and release the 'bots.

When activated the 'bots perform a scan of the vessels systems, and by comparing what they find with their in-build blueprints they can identify which (if any) system or systems are damaged. From this they will select which item they want to repair (this is limited to a single item as a further Galcop mandated safety measure to prevent runaway replication) and proceed to attempt work on it.

Please note that whilst these useful little creatures won't stop to take coffee breaks or chat-up the pilot's girlfriend, they are only as reliable as their in-built blueprints. So for more complicated systems and for some variant items sold by various companies, there is a chance that they will not be able to fully repair all items before their mandatory limited lifespan expires. In this case the usage of an additional cannister or two of 'bots may assist with the problem.

Now featuring a lovely new pylon icon for the bots, courtesy of Eldon.

STOP-PRESS! - following some heavy lobbying by the transport haulers oonion, Galcop have relaxed their rules about storage of the nanobots. So the ASC are now very proud to announce the introduction of their patent Repair System. Built into the workings and systems of the customer ship, it automatically attempts to repair any broken equipment using its own supply of bots. No missile pylons have to be sacrificed to the gods of fixing stuff, but consumes one energy unit per second while effecting repairs, going dormant if there is only one energy bank available and re-starting when the ship has to two full energy banks again.

There are two versions available: the standard one occupies 2t of cargo space and holds nanobots to effect up to ten repairs, and a light version that occupies 1t of cargo sapce and holds nanobots for 5 repairs. The recharge packs of nanobots come in two sizes, a 10-pack for up to ten repairs and a 5-pack for up to 5 repairs.

Repair System Standard:
Cost: 12000 Cr.
Techlevel: 11 
Repair System Light:
Cost: 10000 Cr.
Techlevel: 12 
Repair System Recharge, 10-Pack:
Cost: 1000 Cr.
TechLevel: 9 
Repair System Recharge, 5-Pack:
Cost: 600 Cr.
Techlevel: 9 
Repair Nanobots (pylon mounted):
Cost: 3000 Cr.
Techlevel: 9

==Requirements==
This OXP requires at least test version 1.74 of Oolite.

==Download==

[[Media:RepairBots-2.14.oxz|RepairBots_2.14.oxz]] (downloaded {{#downloads:RepairBots-2.14.oxz}} times).

Old versions:

[[Media:RepairBots-2.13.oxz|RepairBots_2.13.oxz]] (downloaded {{#downloads:RepairBots-2.13.oxz}} times).

[[Media:RepairBots-2.12.oxz|RepairBots_2.12.oxz]] (downloaded {{#downloads:RepairBots-2.12.oxz}} times).

[[Media:RepairBots-2.11.oxz|RepairBots_2.11.oxz]] (downloaded {{#downloads:RepairBots-2.11.oxz}} times).

[[Media:RepairBots_2.10.oxz|RepairBots_2.10.oxz]] (downloaded {{#downloads:RepairBots_2.10.oxz}} times).

==Tweaks==
*[http://aegidian.org/bb/viewtopic.php?p=253573#p253573 Souping-up the Repair-bots] (2017)
*You might find [[How to tweak OXZ's]] helpful!

==Notes for OXP developers==
The new and improved repair bots have a chance to repair anything installed on the ship. Any OXP writer who wishes to alter this for their own OXP simply needs to add the line:

script_info = { thargoidRepairBotChance = X; };

into their equipmentInfo.plist file entry for the equipment in question - replacing X with the numerical value between 0 (never repaired) and 1 (always repaired). If no such entry is made the repair chance will be based on the equipment's tech level.

Other OXPs can also temporarily inhibit Repair Bots from repairing an equipment through the use of the disabling/enabling equipment functions described bellow.

;<code>worldScripts["Repair System"].$disableEquipment(eqKey, who, why)</code>
:<code>eqkey</code>: string, equipment key
:<code>who</code>: string, identifies the caller
:<code>why</code>: string, describes the reason why the equipment is disabled

:Sets the equipment as DAMAGED and inserts it in the disabled equipment list (equipment in th disabled list is not repaired)

;<code>worldScripts["Repair System"].$enableEquipment(eqKey, who)</code>
:<code>eqkey</code>: string, equipment key
:<code>who</code>: string, identifies the caller

:Removes the caller from the disablers of the equipment and if there is no disabler left, sets the equipmenty status to OK

==Version History==

17/08/2022 - Version 2.14
*Changes the to remove the "Thargoid clauses" after Thargoid allowed modification when retired from maintaining his OXPs (http://aegidian.org/bb/viewtopic.php?f=4&t=17085).
*Fixes typo that prevented resuming operation after a low energy period (thanks to cag and UK_Eliter!).

04/10/2020 - Version 2.13
*Energy thresholds are now proportional to the ship's maxEnergy and not absolute: repair stops when energry drops to 20% and resumes when it reaches 40%.
*Self-repair, i.e., repairing the Repair System Controller, consumes 2 charges.
*ew functions for other OXPs tell Repair Systems that an equipment is disabled, i.e., it's damaged but should not be repaired. This allows OXPs to inhibit Repair Systems actions on a given equipment during a period of time, while the probabilities in the scriptInfo are "hard-coded", i.e., can't be changed by scripts.

14/09/2020 - Version 2.12
*checks for repair controller existence before starting the repair system.

24/08/2020 - Version 2.11
*introduced '''Repair System Light''', with 5 charges taking 1 TC of cargo space, and Recharge 5-Pack.
*introduced energy cost while repairing, with minimum of one energy bank to work. (Dybal)

xx/xx/2012 - Version 2.10
*requirement now for 1.77. Restored the 2t space requirement.
*also added an 0.5s delay to activation on damage, to allow other scripts to run first (OXP equipment self-repair and also realistic damage OXP).

07/08/2012 - Version 2.09
*temporary removal of requirement for 2t cargo due to bug in 1.76.1 (rollback of v2.06 in part).

23/07/2012 - Version 2.08
*small bugfix to cope better with selling of ships and persistence of mission variables.

03/06/2012 - Version 2.07
*removing minor glitch so remaining charges only show on F5 manifest screen when the Repair System is actually installed - thanks to JazHaz for the heads-up.

09/05/2012 - Version 2.06
*made repair system require 2t of cargo space ready for v1.77 implementation.
*also will only work for 10 repairs before needing a recharge.

19/03/2012 - Version 2.05
*corrected error in script - thanks to Cmdr Cheyd.

03/11/2011 - Version 2.04
*further optimisation by Eric Walch.

02/11/2011 - Version 2.03
*script speed hack courtesy of Capt. Murphy.

02/04/2011 - Version 2.02
*superb new pylon icon for the repair bot cannister, by Eldon.

13/02/2011 - Version 2.01
*removal of upper limit, to allow running with 1.75.

17/05/2010 - Version 2.00
*update for v1.74 (only) - now uses script to scan players equipment, so can fix anything not explicitly in the exclusion list.
*also new addition of the repair system.

02/09/2009 - Version 1.10
*ditto for v1.73.

10/11/2008 - Version 1.00
*script update for v1.72 compatability.

25/09/2008 - Version 0.99
*pre-release version with some OXP equipment support (more to follow). Inclusion of chance of failure for more complex equipment (above equipment tech level 8) and lowering of price to 3000 credits.

05/09/2008 - Version 0.10
*beta test release.

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.79"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title = Repair Bots
|version = 2.13
|release = 2020-08-24
|features = self-repair
|license = CC BY-NC-SA 3
|category = Equipment OXPs
|author = [[User:Thargoid|Thargoid]]
|download = [[Media:RepairBots-2.11.oxz|Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=20722& BB-Link]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-violet.png]]

==Links==
* [[User:Thargoid|Thargoid's OXP page]].
* [http://aegidian.org/bb/viewtopic.php?f=4&t=20722 BB Thread] (2020)
* [http://aegidian.org/bb/viewtopic.php?f=4&t=18033 BB Thread] (2016)
* [http://aegidian.org/bb/viewtopic.php?f=4&t=5034 BB Thread] (2008)

*[http://bb.aegidian.org/viewtopic.php?f=4&t=13592 External Repair System for subentities]. GGShinobi (2013) Alpha release. (for [[Imperial Courier (Oolite)|rotating nacelles]], [[Z GrOovy HPC pack|landing gear]], ''etc''!)
{{equipment-OXP}}

[[Category:Oolite_expansion_packs]]

Repair Bots OXP

2022-08-17T23:26:02Z

Dybal: /* Download */

[[File:Srs.png|thumb|right|250px|[[Vimana HUD]] icon for SRS Repair NanoBots]]
[[File:Missile, ECM hardened missile, Quirium Cascade Mine, Repair Bots, Salvage Missile.png|thumb|right|250px|missile bay icons: Missile, ECM-hardened missile, Quirium cascade bomb, '''Repair nanobots''', Salvage missile]]
==Overview==
As any commander on the go knows, there is nothing more frustrating than having valuable and necessary equipment getting broken in-flight, usually just before you really need it. So the researchers at the [[Aquarian Shipbuilding Corp. HQ|Aquarian Shipbuilding Corporation]]'s ships equipment division have taken the repair nanobots used on a large scale for station repairs, and adapted them for standard ship usage.

It also now provides a second piece of equipment - the fully mountable repair system. This is true ship's damage control, available to any ship that doesn't already have it built-in. It uses advanced repair bots to control and repair any broken equipment that happens on the ship in-flight.

==Usage==
As standard, the repair 'bots are packaged in a small container which is specially designed to keep them dormant until their services are required. Due to Galcop rules this container is not allowed to be stored within the vessel itself, so the standard solution is to mount it on an empty missile pylon, with the added bonus that the standard missile arming and launching sequence can be used to activate and release the 'bots.

When activated the 'bots perform a scan of the vessels systems, and by comparing what they find with their in-build blueprints they can identify which (if any) system or systems are damaged. From this they will select which item they want to repair (this is limited to a single item as a further Galcop mandated safety measure to prevent runaway replication) and proceed to attempt work on it.

Please note that whilst these useful little creatures won't stop to take coffee breaks or chat-up the pilot's girlfriend, they are only as reliable as their in-built blueprints. So for more complicated systems and for some variant items sold by various companies, there is a chance that they will not be able to fully repair all items before their mandatory limited lifespan expires. In this case the usage of an additional cannister or two of 'bots may assist with the problem.

Now featuring a lovely new pylon icon for the bots, courtesy of Eldon.

STOP-PRESS! - following some heavy lobbying by the transport haulers oonion, Galcop have relaxed their rules about storage of the nanobots. So the ASC are now very proud to announce the introduction of their patent Repair System. Built into the workings and systems of the customer ship, it automatically attempts to repair any broken equipment using its own supply of bots. No missile pylons have to be sacrificed to the gods of fixing stuff, but consumes one energy unit per second while effecting repairs, going dormant if there is only one energy bank available and re-starting when the ship has to two full energy banks again.

There are two versions available: the standard one occupies 2t of cargo space and holds nanobots to effect up to ten repairs, and a light version that occupies 1t of cargo sapce and holds nanobots for 5 repairs. The recharge packs of nanobots come in two sizes, a 10-pack for up to ten repairs and a 5-pack for up to 5 repairs.

Repair System Standard:
Cost: 12000 Cr.
Techlevel: 11 
Repair System Light:
Cost: 10000 Cr.
Techlevel: 12 
Repair System Recharge, 10-Pack:
Cost: 1000 Cr.
TechLevel: 9 
Repair System Recharge, 5-Pack:
Cost: 600 Cr.
Techlevel: 9 
Repair Nanobots (pylon mounted):
Cost: 3000 Cr.
Techlevel: 9

==Requirements==
This OXP requires at least test version 1.74 of Oolite.

==Download==

[[Media:RepairBots-2.14.oxz|RepairBots_2.14.oxz]] (downloaded {{#downloads:RepairBots-2.14.oxz}} times).

Old versions:

[[Media:RepairBots-2.13.oxz|RepairBots_2.13.oxz]] (downloaded {{#downloads:RepairBots-2.13.oxz}} times).

[[Media:RepairBots-2.12.oxz|RepairBots_2.12.oxz]] (downloaded {{#downloads:RepairBots-2.12.oxz}} times).

[[Media:RepairBots-2.11.oxz|RepairBots_2.11.oxz]] (downloaded {{#downloads:RepairBots-2.11.oxz}} times).

[[Media:RepairBots_2.10.oxz|RepairBots_2.10.oxz]] (downloaded {{#downloads:RepairBots_2.10.oxz}} times).

==Tweaks==
*[http://aegidian.org/bb/viewtopic.php?p=253573#p253573 Souping-up the Repair-bots] (2017)
*You might find [[How to tweak OXZ's]] helpful!

==Notes for OXP developers==
The new and improved repair bots have a chance to repair anything installed on the ship. Any OXP writer who wishes to alter this for their own OXP simply needs to add the line:

script_info = { thargoidRepairBotChance = X; };

into their equipmentInfo.plist file entry for the equipment in question - replacing X with the numerical value between 0 (never repaired) and 1 (always repaired). If no such entry is made the repair chance will be based on the equipment's tech level.

Other OXPs can also temporarily inhibit Repair Bots from repairing an equipment through the use of the disabling/enabling equipment functions described bellow.

;<code>worldScripts["Repair System"].$disableEquipment(eqKey, who, why)</code>
:<code>eqkey</code>: string, equipment key
:<code>who</code>: string, identifies the caller
:<code>why</code>: string, describes the reason why the equipment is disabled

:Sets the equipment as DAMAGED and inserts it in the disabled equipment list (equipment in th disabled list is not repaired)

;<code>worldScripts["Repair System"].$enableEquipment(eqKey, who)</code>
:<code>eqkey</code>: string, equipment key
:<code>who</code>: string, identifies the caller

:Removes the caller from the disablers of the equipment and if there is no disabler left, sets the equipmenty status to OK

==Version History==
04/10/2020 - Version 2.13
*Energy thresholds are now proportional to the ship's maxEnergy and not absolute: repair stops when energry drops to 20% and resumes when it reaches 40%.
*Self-repair, i.e., repairing the Repair System Controller, consumes 2 charges.
*ew functions for other OXPs tell Repair Systems that an equipment is disabled, i.e., it's damaged but should not be repaired. This allows OXPs to inhibit Repair Systems actions on a given equipment during a period of time, while the probabilities in the scriptInfo are "hard-coded", i.e., can't be changed by scripts.

14/09/2020 - Version 2.12
*checks for repair controller existence before starting the repair system.

24/08/2020 - Version 2.11
*introduced '''Repair System Light''', with 5 charges taking 1 TC of cargo space, and Recharge 5-Pack.
*introduced energy cost while repairing, with minimum of one energy bank to work. (Dybal)

xx/xx/2012 - Version 2.10
*requirement now for 1.77. Restored the 2t space requirement.
*also added an 0.5s delay to activation on damage, to allow other scripts to run first (OXP equipment self-repair and also realistic damage OXP).

07/08/2012 - Version 2.09
*temporary removal of requirement for 2t cargo due to bug in 1.76.1 (rollback of v2.06 in part).

23/07/2012 - Version 2.08
*small bugfix to cope better with selling of ships and persistence of mission variables.

03/06/2012 - Version 2.07
*removing minor glitch so remaining charges only show on F5 manifest screen when the Repair System is actually installed - thanks to JazHaz for the heads-up.

09/05/2012 - Version 2.06
*made repair system require 2t of cargo space ready for v1.77 implementation.
*also will only work for 10 repairs before needing a recharge.

19/03/2012 - Version 2.05
*corrected error in script - thanks to Cmdr Cheyd.

03/11/2011 - Version 2.04
*further optimisation by Eric Walch.

02/11/2011 - Version 2.03
*script speed hack courtesy of Capt. Murphy.

02/04/2011 - Version 2.02
*superb new pylon icon for the repair bot cannister, by Eldon.

13/02/2011 - Version 2.01
*removal of upper limit, to allow running with 1.75.

17/05/2010 - Version 2.00
*update for v1.74 (only) - now uses script to scan players equipment, so can fix anything not explicitly in the exclusion list.
*also new addition of the repair system.

02/09/2009 - Version 1.10
*ditto for v1.73.

10/11/2008 - Version 1.00
*script update for v1.72 compatability.

25/09/2008 - Version 0.99
*pre-release version with some OXP equipment support (more to follow). Inclusion of chance of failure for more complex equipment (above equipment tech level 8) and lowering of price to 3000 credits.

05/09/2008 - Version 0.10
*beta test release.

==Quick Facts==
{{OXPLevel|0}}{{IconOXP|ooVersion="1.79"|oxpCPU="Average"|oxpMEM="Average"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title = Repair Bots
|version = 2.13
|release = 2020-08-24
|features = self-repair
|license = CC BY-NC-SA 3
|category = Equipment OXPs
|author = [[User:Thargoid|Thargoid]]
|download = [[Media:RepairBots-2.11.oxz|Download]]
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=20722& BB-Link]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-violet.png]]

==Links==
* [[User:Thargoid|Thargoid's OXP page]].
* [http://aegidian.org/bb/viewtopic.php?f=4&t=20722 BB Thread] (2020)
* [http://aegidian.org/bb/viewtopic.php?f=4&t=18033 BB Thread] (2016)
* [http://aegidian.org/bb/viewtopic.php?f=4&t=5034 BB Thread] (2008)

*[http://bb.aegidian.org/viewtopic.php?f=4&t=13592 External Repair System for subentities]. GGShinobi (2013) Alpha release. (for [[Imperial Courier (Oolite)|rotating nacelles]], [[Z GrOovy HPC pack|landing gear]], ''etc''!)
{{equipment-OXP}}

[[Category:Oolite_expansion_packs]]

File:RepairBots-2.14.oxz

2022-08-17T23:25:14Z

Dybal: Version 2.14

== Summary ==
Version 2.14

ILS

2022-08-11T19:41:24Z

Dybal: /* Changelog */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not necessary
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is in the "outside" side of the dock entrance's plane
(avoids trying to dock through the dock's walls...).
Stops Liners and Dredgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

Old versions:

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] (Slartifbartfast, 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.14
|release = 2022-08-08
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-08-11T19:37:38Z

Dybal: /* Description */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not necessary
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)
* if in red alert, the weapons are offline

Note that engaging automatically means there is NO on/off switch for ILS. The commander can stop the ship by reducing thrust to zero though (to avoid a collision, for example).

If the target lock is changed or removed, ILS disengages automatically... beware Telescope auto-locking!

The commander can avoid engaging ILS by using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, ILS will disengage and the Dredger will be free to start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is "outside" the dock entrance's plane
(avoids trying to dock through the dock's walls...).
Stops Liners and Dedgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

Old versions:

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] (Slartifbartfast, 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.14
|release = 2022-08-08
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

ILS

2022-08-11T19:27:46Z

Dybal: /* Description */

'''Instrument Landing System'''
=== Description ===

Once installed and engaged, ILS will steer the ship through docking, synchronizing its rotation the the station's if necessary. The commander should control the ship's speed and pay attention in case some other ship launches from the station
as his/her ship approaches. The commander can even use Injectors at the early approach to dock faster, though it's prudent to reduce speed closer to the dock.

The ILS mark the current waypoint with a white flashing lightball which will approach the dock as the commander gets nearer to the station. The commander can temporary override the ILS steering (to avoid a collision with a launching ship, for example) but when the controls are released ILS will resume steering the ship to the waypoint again.

[[Image:ils.jpg]]

ILS engages automatically if all the following conditions apply:
* the station is locked with an indent lock (the "r" key - NOT the missile lock "t" key!)
* the commander has asked for docking clearance
* the commander received docking clearance, or it's not necessary
* the commander ship is "beyond" the plane that would close the dock's entrance ("beyond" meaning the side of the plane that faces the outside, not the side that faces the dock's inside and the station)

Note that there is '''no''' on/off switch for ILS. You can stop if needed by reducing your thrust to zero, to avoid a collision for example.

If you change or remove the target lock the ILS turn disengages automatically... beware Telescope auto-locking!

Another way to avoid engaging ILS is using the missile targeting mode: use the "t" key instead of "r" to lock a station and ILS will not switch on.

No ILS in red alert except if weapons are offline.

ILS will rotate your ship in the last 2km if your ship is wider than the height of the dock.

ILS will even convince those stubborn Liners to stop while you are docking. Dredgers will stop as you ask for docking clearance...

ILS will disengage automatically when the docking clearance expires, so beware when docking to stations that do not require docking clearance... Dredgers included: once the clearance expires, it will start moving in "collision avoidance" mode. To avoid that, keep asking for docking clearance as you approach the dock (once each 30s should do it).

Cost: 50.0₢
Techlevel: 5

=== No more traffic jams! ===

NPC ships can dock much faster with ILS, using a shorter path and injectors, narrow ones without roll. This helps cure traffic jams near stations when you are waiting for landing clearance. You don't need to buy the ILS equipment yourself, just keep the .oxp installed and all the NPCs will use it! Injector-equipped ships will arrive in seconds, slowing down in the last 2km only.

[[Image:Ils_npc.png]]

You must wait until the current ILS-user ship is docked before you can use ILS.

If you target the station while another ship is using ILS then you lock on the landing ship - a help to find where it is. If you keep the station in your crosshairs when the current ship arrives into the dock then you get the right to use ILS regardless of whether there are others in the queue.

Alternatively you can wait until all ships arrive into the dock - you cannot break off an already started ILS approach.

=== Warning ===
If you do not know what you are doing, this can be a very effective way of visiting [[Church of Giles the Creator#Eschatology|St Giles in The Pool of Pellucid Placidity]]! Or losing cargo or damaging your craft! Note that as your shields improve ([[Shield Boosters]] & [[Military Shield Enhancement]]), the speed at which you can survive increases too! The most common issues are:
* the ILS targeting something else which comes into its sight during the docking procedure - and either ILS looses its lock on the dock, or it fixates on another dockable and goes after that - in either case the change of direction can incur fatal consequences (this can actually happen ''inside'' the docking tunnel of hermits, for example);

*''Combining ILS with Telescope increases the opportunities for the loss of one's third dimension.''

Advice: In such cases (and ''especially'' when approaching large moving objects such as Behemoths/Liners/Deep Space Dredgers) it is usually safest to detour around the object so that you can approach it from the side of the docking bay, thus limiting the gyrations required for the operation. If docking clearance protocols are not enabled (one of the F2 game options), then you can repeatedly press "L" which inhibits the objects own gyrations.

=== Dependencies ===
Oolite v1.79 or later.

=== Instructions ===
Do not unzip the .oxz file, just move into the AddOns folder of your Oolite installation.

=== License ===
This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License version 4.0.
If you are re-using any piece of this OXP, please let me know by sending an e-mail to norbylite at gmail.com.

=== Changelog ===
2022.08.08. v1.14 Makes asking for docking clearance necessary for the player to engage ILS.
Player gets ILS use when docking clearance is granted.
Restored making the current ILS user the player's target while the player waits for
docking clearance.
ILS is enabled for NPCs in the last station the player docked until the player moves
100km away from it, when ILS will be enabled at the main station to reduce the
probability of a traffic jam.
Frees ILS for NPC use once the player has docked.
ILS does not engage until the player's ship is "outside" the dock entrance's plane
(avoids trying to dock through the dock's walls...).
Stops Liners and Dedgers while player uses ILS to dock with them.
2020.08.12. v1.13 Calculate Dock world-coordinates orientation by concatenating its orientation in
station model-coordinates with the Station orientation in world-coordinates.
Get direction of Dock widest dimension (depth excluded) based on Docks dimensions
and world-coordinates orientation (general case, should work for all kinds of
dock's placement on station models).
Use Dock's heading instead of Station's heading to get the position to aim on
approach.
Change rotation sync logic: if the ship's rotation is lagging, rotates in the same
direction as the station; if it's advanced, rotate against the station; this avoids
rotating too much inside the dock if a longer interval between FCB calls gets the
ship sufficiently out-of-sync to start correcting again (the "let's rotate once
more now we are inside the dock" bug...).
Limit ship's rotation in rotation sync to the max roll that ship can do in the FCB
time interval.
If the ship is approaching fast, start rotation sync farther away and rotate as
much as possible in each FCB call, otherwise do it more leisurely (for the visual
beauty... might be still too fast for that and need some tuning).
2020.07.16. v1.12 Off-centre dock alignment fix for player and NPC's, performance enhancements,
improvements to auto-docking movements. Thanks to dybal.
2016.05.20. v1.11 Rotation fix at Torus stations, thanks to pkhb.
Smoother start of ILS steering as the ship has inertia.
2016.03.27. v1.9 ILS will rotate your ship in the last 2km if wider than the height of the dock.
Wide NPCs can rotate before dock to prevent lockdown at non-rolling stations.
NPC will slow during ILS approach when a ship is near to prevent collision.
Use less CPU by searching new ships in timer instead of FCB.
Fixed a minor bug in NPC logic when player launch.
2016.01.11. v1.8 Display a warning message if you must roll to fit into the dock.
No ILS in red alert except if weapons are offline.
NPCs will not dock until player has docking clearance.
NPCs will not use ILS at moving docks like Behemoth.
Landing NPC will stop when player launch from a station.
No more auto target lock on new ILS user NPCs.
2015.11.29. v1.7 Wide NPCs can use ILS, these will wait for the right position.
Lonq queues finish faster due to the speed based selection of next NPC.
Auto switch to the next ship when the current ILS user suffer attack.
No more "ILS set to" message when player is docked.
2015.11.28. v1.6 NPC ILS improved: earn higher speed and up to 95m width for Krait.
Must wait NPC to dock before ILS can be used by the player.
Targeted NPC will not get priority over others.
2015.11.27. v1.5 Most NPC ships can dock faster without roll, up to 80m width.
2015.03.21. v1.4 Fixed landing in Rock Hermits.
Fixed a bug with Towbar.
2014.10.01. v1.3 No ILS in missile targeting mode.
ILS steering suspended until player ship is stopped.
Fixed Telescope visual target shaking during ILS steering.
Using reduced turn rates when there is a ship on Towbar.
2014.09.30. v1.2 Refined approaching curve with less sharp turn at the end.
Fixed the white marker.
2014.09.29. v1.1 Small fixes, for example Carriers will not turn on ILS.
2014.09.29. v1.0 First release.

=== Download ===

[[Media:ils-1.14.oxz‎|ILS-1.14.oxz‎]] (downloaded {{#downloads:ils-1.14.oxz‎}} times).

Old versions:

[[Media:ils-1.13.oxz‎|ILS-1.13.oxz‎]] (downloaded {{#downloads:ils-1.13.oxz‎}} times).

[[Media:ILS.1.12.oxz‎|ILS.1.12.oxz‎]] (downloaded {{#downloads:ILS.1.12.oxz‎}} times).

[[Media:ILS.1.11.oxz‎|ILS.1.11.oxz‎]] (downloaded {{#downloads:ILS.1.11.oxz‎}} times).

[[Media:ILS.1.9.oxz‎|ILS.1.9.oxz‎]] (downloaded {{#downloads:ILS.1.9.oxz‎}} times).

[[Media:ILS.1.8.oxz‎|ILS.1.8.oxz‎]] (downloaded {{#downloads:ILS.1.8.oxz‎}} times).

[[Media:ILS.1.7.oxz‎|ILS.1.7.oxz‎]] (downloaded {{#downloads:ILS.1.7.oxz‎}} times).

[[Media:ILS.1.4.oxz‎|ILS.1.4.oxz‎]] (downloaded {{#downloads:ILS.1.4.oxz‎}} times).

===Tweaks===
*[http://www.aegidian.org/bb/viewtopic.php?p=285078#p285078 To make ILS removable (costs 25₢)] (Slartifbartfast, 2022)
:You might wish to consult [[How to tweak OXZ's]]

===Quick Facts===
{{OXPLevel|2}}{{Infobox OXPb| title = ILS
|version = 1.14
|release = 2022-08-08
|features = Landing System
|license = CC BY-NC-SA 4
|category = Equipment OXPs
|author = [[User:Norby|Norby]]
|feedback = [http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link]
}}

=== Links ===
*[http://bb.aegidian.org/viewtopic.php?f=4&t=16916 BB-Link] (2014 - date)
*[http://aegidian.org/bb/viewtopic.php?p=41519#p41519 Is it possible to "steer" the player ship?] (2015)

NPC Energy Units OXP

2022-08-10T23:17:31Z

Dybal: /* Version History */

== Description ==

NPC Energy Units OXP aims to make the energy units in NPC ships operational, enhancing the NPCs energy recharge rate.

For those NPC ships created with the energy units, this OXP will enable them by itself, for those ships whose energy units were granted by OXPs after the ship was spawned, this OXP makes available a function for the awarding OXP to call to enable the awarded energy unit.

This OXP also awards energy units (civilian and naval) to NPCs, based on their accuracy (the higher accuracy have greater probability of getting them) and recharge rate (the higher recharge rates have lesse probability of getting the energy units).

== Notes for OXP developers ==

This OXP makes available the following functions:

* <code>worldScripts.NPC_Energy_Units.$getShipEnergyUnit(ship)</code>

:A convenience function that returns the equipment Key for any energy unit installed on the ship, or null if the ship has none.

* <code>worldScripts.NPC_Energy_Units.$setupEnergyUnits(ship)</code>

:Updates the ship's energy recharge rate to the factory value boosted by the energy unit installed, if it's not damaged.
:Returns true if the ship's energy recharge was modified and false otherwise.

* <code>worldScripts.NPC_Energy_Units.$energyUnitDamaged(equipmentKey)</code>

:An event handler for damage to energy units, it MUST be called in the context ('this') of the ship's script, as in:

worldScripts.NPC_Energy_Units.$energyUnitDamaged.call(ship.script, equipmentKey)

:It restores the ship to its factory energy recharge rate if the equipmentKey is an energy unit and its status in the ship isn't EQUIPMENT_OK: it can be called after an energy unit is removed from the ship to reset its energy recharge rate, but that means that if the ship has a naval energy unit and this function is called with the key for an extra energy unit, the ship's energy recharge rate WILL be reset, rendering the naval energy unit non-functional.

:This OXP includes this function in NPC Equipment Damage OXP list of equipment damage handlers if that OXP is installed.

== License ==

This OXP is licensed under the [https://creativecommons.org/licenses/by-sa/4.0/legalcode CC-BY-SA 4.0].

== Aknowledgements ==

This OXP is based on Ngalo's original NPC Energy Unit.

I would rather have updated the original OXP, but although it had a CC BY-NC-SA, it didn't specify the version, so I opted to write a new one to replace it just to be in safe licensing grounds.

== Downloads ==

The latest version is available on the Expansion Manager and here: [[Media:npcEnergyUnits-1.0.2.oxz|NPC Energy Units v1.0.2]]

== Version History ==

Version 1.0.2 (july/2022):
* Fixes damage handler exported to NPC Equipment Damage OXP (it's called for any equipment damaged ina NPC, not only energy units, as it formerly expected).
* Removes some redundant logging messages.
* Don not award energy units to NPX of low accuracy (less than 0), since they are too green/incompetent to afford them.
* Reduces the probablities for awarding Naval Energy Units (they should be rare), making sure high recharging rate ships (7 or greater) do not get them.

Version 1.0.1 (december/2020):

* Adds _alreadyGotOne array (with ships that have high energy recharge rate to emulate an energy unit) for backwards compatibility with Ngalo's version (and used by Military Shields OXP).
* Changes parameters for granting NEU and EEU to reduce probability of granting to ships with recharge rate above 6.

Version 1.0 (november/2020):

* Initial version

== Quick Facts ==

{{OXPLevel|5}}
{{IconOXP|ooVersion="1.82"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title NPC Energy Units
|version = 1.0.2
|release = 2022-07-03
|license = CC-BY-SA 4.0
|features = Enables the NPCs energy units
|category = Mechanics OXPs
|author = [[User:Dybal|Dybal]]
|feedback = [http://www.aegidian.org/bb/viewtopic.php?f=4&t=18161 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

{{Mechanics-OXP}}

NPC Energy Units OXP

2022-08-10T23:16:13Z

Dybal: /* Quick Facts */

== Description ==

NPC Energy Units OXP aims to make the energy units in NPC ships operational, enhancing the NPCs energy recharge rate.

For those NPC ships created with the energy units, this OXP will enable them by itself, for those ships whose energy units were granted by OXPs after the ship was spawned, this OXP makes available a function for the awarding OXP to call to enable the awarded energy unit.

This OXP also awards energy units (civilian and naval) to NPCs, based on their accuracy (the higher accuracy have greater probability of getting them) and recharge rate (the higher recharge rates have lesse probability of getting the energy units).

== Notes for OXP developers ==

This OXP makes available the following functions:

* <code>worldScripts.NPC_Energy_Units.$getShipEnergyUnit(ship)</code>

:A convenience function that returns the equipment Key for any energy unit installed on the ship, or null if the ship has none.

* <code>worldScripts.NPC_Energy_Units.$setupEnergyUnits(ship)</code>

:Updates the ship's energy recharge rate to the factory value boosted by the energy unit installed, if it's not damaged.
:Returns true if the ship's energy recharge was modified and false otherwise.

* <code>worldScripts.NPC_Energy_Units.$energyUnitDamaged(equipmentKey)</code>

:An event handler for damage to energy units, it MUST be called in the context ('this') of the ship's script, as in:

worldScripts.NPC_Energy_Units.$energyUnitDamaged.call(ship.script, equipmentKey)

:It restores the ship to its factory energy recharge rate if the equipmentKey is an energy unit and its status in the ship isn't EQUIPMENT_OK: it can be called after an energy unit is removed from the ship to reset its energy recharge rate, but that means that if the ship has a naval energy unit and this function is called with the key for an extra energy unit, the ship's energy recharge rate WILL be reset, rendering the naval energy unit non-functional.

:This OXP includes this function in NPC Equipment Damage OXP list of equipment damage handlers if that OXP is installed.

== License ==

This OXP is licensed under the [https://creativecommons.org/licenses/by-sa/4.0/legalcode CC-BY-SA 4.0].

== Aknowledgements ==

This OXP is based on Ngalo's original NPC Energy Unit.

I would rather have updated the original OXP, but although it had a CC BY-NC-SA, it didn't specify the version, so I opted to write a new one to replace it just to be in safe licensing grounds.

== Downloads ==

The latest version is available on the Expansion Manager and here: [[Media:npcEnergyUnits-1.0.2.oxz|NPC Energy Units v1.0.2]]

== Version History ==

Version 1.0.1 (december/2020):

* Adds _alreadyGotOne array (with ships that have high energy recharge rate to emulate an energy unit) for backwards compatibility with Ngalo's version (and used by Military Shields OXP).
* Changes parameters for granting NEU and EEU to reduce probability of granting to ships with recharge rate above 6.

Version 1.0 (november/2020):

* Initial version

== Quick Facts ==

{{OXPLevel|5}}
{{IconOXP|ooVersion="1.82"|oxpCPU="Low"|oxpMEM="Low"|oxpGPU="Low"|oxpIsAPI=true|oxpIsDocumented=true}}
{{Infobox OXPb| title NPC Energy Units
|version = 1.0.2
|release = 2022-07-03
|license = CC-BY-SA 4.0
|features = Enables the NPCs energy units
|category = Mechanics OXPs
|author = [[User:Dybal|Dybal]]
|feedback = [http://www.aegidian.org/bb/viewtopic.php?f=4&t=18161 Oolite BB]
}}

== Gameplay and Balance indicator ==
[[File:Tag-colour-red.png]]

{{Mechanics-OXP}}