View source for Friend or Foe/AI sendScriptMessage functions

This is a list of all <code>sendScriptMessage</code> functions that can be used with the AI of a ship.

==== <code>$fof_alterDockEscorts</code> ====
In standard Oolite, escorts will be unlinked from the mothership and assigned a standard docking AI. This will alter the docking AI to the [[Friend_or_Foe|Friend or Foe]] OXP aware docking AI for the ex-escorts of the calling ship after a <code>dockEscorts</code> AI command has been issued. Send the message before <code>dockEscorts</code> is called.

Example:
  <code>"AEGIS_IN_DOCKING_RANGE" = ("sendScriptMessage: $fof_alterDockEscorts", dockEscorts);</code>

==== <code>$fof_checkTargetIsValid</code> ====
Checks the current target of the calling ship to make sure it is still valid.

Example:
  <code>UPDATE = ("pauseAI: 10.0", "sendScriptMessage: $fof_checkTargetIsValid");</code>
<code>TARGET_LOST</code> is returned to the calling ship AI if the current target is lost or becomes invalid.

==== <code>$fof_performAttackTarget</code> ====
This does something similar to a mix between the deployEscorts and groupAttackTarget AI commands.

Example:
  <code>"MISSILE_INCOMING" = (setTargetToPrimaryAggressor, "sendScriptMessage: $fof_performAttackTarget");</code>
<code>FOF_ATTACK_TARGET</code> is returned to the calling ship AI. A selection of ships in the same group as the calling ship will have their target set to the current target and their AI will also receive <code>FOF_ATTACK_TARGET</code>.

==== <code>$fof_scanForAttackers</code> ====
Scan for current ships or players from the past that have attacked the calling ship. Also scan for potential attackers.

Example:
  <code>UPDATE = ("pauseAI: 10.0", "sendScriptMessage: $fof_scanForAttackers");</code>
Reacts with an <code>ATTACKERS_FOUND</code> AI message if there are attackers near the calling ship. Otherwise <code>ATTACKERS_NOT_FOUND</code> is returned to the calling ship AI.

==== <code>$fof_scanForCascadeWeapon</code> ====
Scan for cascade weapons near the calling ship. This will allow versions of Oolite older than v1.77 to react to cascade weapons.

Example:
  <code>UPDATE = ("pauseAI: 10.0", "sendScriptMessage: $fof_scanForCascadeWeapon");</code>
Reacts with a <code>CASCADE_WEAPON_FOUND</code> AI message rather than <code>CASCADE_WEAPON_DETECTED</code> which is used by Oolite v1.77 and newer.

----
[[Category:OXP API's]]