Escort Instructions - Revision history

Debresser: Page moved. No need for _ in links.

2016-01-16T20:34:32Z

Page moved. No need for _ in links.

Cim: Note the documentation of coordinatesForEscortPosition, add a couple more examples of OXPs using it

2012-07-04T18:21:19Z

Note the documentation of coordinatesForEscortPosition, add a couple more examples of OXPs using it

Eric Walch: Added another link to bb for escort formations

2012-07-02T19:26:24Z

Added another link to bb for escort formations

Eric Walch: Added link to custom escorts

2012-07-02T19:20:07Z

Added link to custom escorts

Eric Walch: Updated page to current behaviour (e.g. setUpEscorts was a useless command in current Oolite)

2011-01-24T12:30:09Z

Updated page to current behaviour (e.g. setUpEscorts was a useless command in current Oolite)

SimonRaven: /* Creating a spread group */

2008-06-15T22:09:22Z

‎Creating a spread group

SimonRaven: /* Creating a spread group */

2008-06-15T22:07:49Z

‎Creating a spread group

SimonRaven: /* Adding escorts from scratch */

2008-06-15T22:01:15Z

‎Adding escorts from scratch

SimonRaven: /* Adding of mother ship */

2008-06-15T21:41:52Z

‎Adding of mother ship

Eric Walch: typo's

2007-12-09T13:14:39Z

typo's

@@ Line 81: / Line 81: @@
 == Setting custom escort formations ==
-Since Oolite 1.75 we have an even better way to define custom escort positions that can be set dynamically with a function. This is achieved with the [[Oolite_JavaScript_Reference:_ship_script_event_handlers#coordinatesForEscortPosition|coordinatesForEscortPosition]] ship script event handler, and allows any escort formation to be defined (including escort formations which vary over time, or in response to events). Examples of use can be found in several OXPs - the cruiser of [[Ixian Ships]], the [[Deep Space Dredger]], and the [[Thargoid Carrier]] all define a different escort formation to the standard 'V' shape.
+Since Oolite 1.75 we have an even better way to define custom escort positions that can be set dynamically with a function. This is achieved with the [[Oolite JavaScript Reference: Ship script event handlers#coordinatesForEscortPosition|coordinatesForEscortPosition]] ship script event handler, and allows any escort formation to be defined (including escort formations which vary over time, or in response to events). Examples of use can be found in several OXPs - the cruiser of [[Ixian Ships]], the [[Deep Space Dredger]], and the [[Thargoid Carrier]] all define a different escort formation to the standard 'V' shape.
 Return to [[OXP howto AI]]

← Older revision		Revision as of 18:21, 4 July 2012
Line 79:		Line 79:
	}		}

−	Since Oolite 1.75 we have an even better way to define custom escort positions that can even be set dynamically with a function. (Documentation has to be written. For now, see [http://aegidian.org/bb/viewtopic.php?p=127793#p127793 this announcement topic] and the [http://aegidian.org/bb/viewtopic.php?p=130613 discussion here] for a brief overview. An example of use can be found in the cruiser of [[Ixian_Ships]]
		+	== Setting custom escort formations ==
		+
		+	Since Oolite 1.75 we have an even better way to define custom escort positions that can be set dynamically with a function. This is achieved with the [[Oolite_JavaScript_Reference:_ship_script_event_handlers#coordinatesForEscortPosition\|coordinatesForEscortPosition]] ship script event handler, and allows any escort formation to be defined (including escort formations which vary over time, or in response to events). Examples of use can be found in several OXPs - the cruiser of [[Ixian Ships]], the [[Deep Space Dredger]], and the [[Thargoid Carrier]] all define a different escort formation to the standard 'V' shape.

	Return to [[OXP howto AI]]		Return to [[OXP howto AI]]

@@ Line 79: / Line 79: @@
+ }
-Since Oolite 1.75 we have an even better way to set custom escort positions that can even set dynamically with a function. (Documentation has to be written. For now, see [http://aegidian.org/bb/viewtopic.php?p=127793#p127793 this announcement topic] for a brief overview. An example of use can be found in the cruiser of [[Ixian_Ships]]
+Since Oolite 1.75 we have an even better way to define custom escort positions that can even be set dynamically with a function. (Documentation has to be written. For now, see [http://aegidian.org/bb/viewtopic.php?p=127793#p127793 this announcement topic] and the [http://aegidian.org/bb/viewtopic.php?p=130613 discussion here] for a brief overview. An example of use can be found in the cruiser of [[Ixian_Ships]]
 Return to [[OXP howto AI]]

@@ Line 48: / Line 48: @@
 ==Creating a spread group==
-When the desired range is set at 0.0 with using '''performEscort''' the escorts group into a V-shape. With higher values the V-shape is not so clear. You can also create a more spread out group by giving members a different distance. See next escortAI where a die roll is used to give members different distances. A die roll is also used in the FOLLOW_LEADER state to avoid the situation where all ships at once react to a '''groupAttackTarget''' message from the mother.
+When the desired range is set at 0.0 with using '''performEscort''' the escorts group into a V-shape. With higher values the V-shape is not so clear. You can also create a more spread out group by giving members a different distance. See next escortAI where a dice roll is used to give members different distances. A dice roll is also used in the FOLLOW_LEADER state to avoid the situation where all ships at once react to a '''groupAttackTarget''' message from the mother.
+ {
@@ Line 78: / Line 78: @@
        };
+ }
 Return to [[OXP howto AI]]

@@ Line 1: / Line 1: @@
 ==Adding of mother ship==
 By default all ships get an escort with role "escort" and only ships with role "police" get an escort with role "wingman".
-This default can be overruled by the keys "escort-role" or " escort-ship" in shipData.plist. When a key "escort-role" exist, escorts with this role are chosen and they keep their original role. (this is a bug because the mother will only accept escorts with role "escort"). When a key " escort-ship" exists, a ship with this name is used as escort and they get the role "escort".
+This default can be overruled by the keys "escort_role" or " escort_ship" in shipData.plist. When a key "escort_role" exist, escorts with this role are chosen and their primaryRole is changed to "escort". When a key "escort_ship" exists, a ship with this name is used as escort and they get the role "escort".
-When setup is ready they all have a '''escortAI.plist''' statemachine and the state itself is set to "FLYING_ESCORT". The initial part in this AI were the escorts are setup is skipped as the escorts are already setup by the system. When you want to give you escorts a custom AI you can redefine this by adding the command: "'''switchAITo: yourCustomAI.plist'''" in  the ships "launch_actions" in the shipData.plist.
+When setup is ready they all have a '''escortAI.plist''' statemachine and the state itself is set to "FLYING_ESCORT". The initial part in this AI were the escorts are setup is skipped as the escorts are already setup by the system. When you want to give you escorts a custom AI you can set the auto_ai key to false or add a JS ship-script that sets parameters on addition.
 ==Adding escorts from scratch==
@@ Line 36: / Line 34: @@
 ==The escortAI.plist==
-Most escorts fly with this AI and the '''setUpEscorts''' function forces the AI to start with the "FLYING_ESCORT" state. When an escort is hit it receives an "ATTACKED" message but will do nothing with it other than giving this message further to the mother. The mother can react in two ways.
+Most escorts fly with this AI and on creation, the AI is forced to start with the "FLYING_ESCORT" state. When an escort is hit it receives an "ATTACKED" message but will do nothing with it other than giving this message further to the mother. The mother can react in two ways.
 : Issue a "GROUP_ATTACK_TARGET" with the command '''groupAttackTarget'''. The escortAI.plist will then as reaction set the  AI to interceptAI.plist.
@@ Line 53: / Line 51: @@
+ {
- GLOBAL = {ENTER = (); EXIT = (); UPDATE = ("pauseAI: 2.0", "setStateTo: ROLL_DICE"); };
+ GLOBAL = {UPDATE = ("pauseAI: 2.0", "setStateTo: ROLL_DICE"); };
  "ROLL_DICE" = {
       ENTER = ("rollD: 5");
@@ Line 61: / Line 59: @@
       "ROLL_4" = ("setDesiredRangeTo: 1600", "setStateTo: FIND_LEADER");
       "ROLL_5" = ("setDesiredRangeTo: 2100", "setStateTo: FIND_LEADER");
       };
  "FIND_LEADER" = {
       ATTACKED = (setTargetToFoundTarget, "setStateTo: ATTACK_SHIP");
       "TARGET_FOUND" = (setTargetToFoundTarget, "setStateTo: FOLLOW_LEADER");
@@ Line 71: / Line 66: @@
       "INCOMING_MISSILE" = (fightOrFleeMissile, "setStateTo: FLEE");
       UPDATE = (scanForFormationLeader, "pauseAI: 3.0");
       };
  "FOLLOW_LEADER" = {
@@ Line 82: / Line 76: @@
       ESCORTING = (performEscort);
       UPDATE = (escortCheckMother, "pauseAI: 15");
-      EXIT = ();
+       };
+ }

@@ Line 48: / Line 48: @@
 With the command "messageMother: YOUR_MESSAGE", the mother gets "'''YOUR_MESSAGE'''" as priority message. You can attach commands to this self defined message like any other system message. The mother immediately reacts to it.
-==Creating a spreaded group==
+==Creating a spread group==
 When the desired range is set at 0.0 with using '''performEscort''' the escorts group into a V-shape. With higher values the V-shape is not so clear. You can also create a more spreaded group by giving members a different distance. See next escortAI were a dice is used to give members different distances and a dice is also used in the FOLLOW_LEADER state to avoid that all ships at once react to a '''groupAttackTarget''' message from the mother.

@@ Line 24: / Line 24: @@
 : It must have a role of escort and the mother must not have the role "escort".
     (or it must be wingman and the mother police or interceptor)
-: The mother has not yet the maximum numbers of escorts.
+: The mother has not yet reached the maximum number of escorts.
-When the escort is accepted by the mother it obtains the group ID of the mother, the mother is set as owner and the escort AI receives an "ESCORTING" message. When the escort was clean, it receives the mothers legal status increased with a small random number.
+When the escort is accepted by the mother it obtains the group ID of the mother, the mother is set as owner, and the escort AI receives an "ESCORTING" message. When the escort was clean, it receives the mothers legal status increased with a small random number.
 When the escort is rejected the AI gets: "NOT_ESCORTING".
-The requirement of having a role of "escort" makes it difficult for a normal ship getting accepted. (Starting with oolite 1.70 you can use the command: "'''setPrimaryRole:''' " to change a shiprole with an AI command). Also escorts introduced by the key "escort-role" will have the wrong role for being added afterwards.
+The requirement of having a role of "escort" makes it difficult for a normal ship getting accepted. (Starting with oolite 1.70 you can use the command: "'''setPrimaryRole:''' " to change a ship role with an AI command). Also escorts introduced by the key "escort-role" will have the wrong role for being added afterwards.
 ==Maintaining escort function==

@@ Line 3: / Line 3: @@
 ==Adding of mother ship==
-When a mother ship is added to the universe it is checked if it can have escorts. If yes, the system is examined and a random number of 0, 2, 4 or 6 is subtracted from the maximum escort number. In saver systems it is more likely that escorts are subtracted. When the resulting number is greater than 0 this number of escorts is added as escort with the function '''setUpEscorts''' and the '''escortsAreSetup''' flag is set.
+When a mother ship is added to the universe it is checked if it can have escorts. If yes, the system is examined and a random number of 0, 2, 4 or 6 is subtracted from the maximum escort number. In safer systems it is more likely that escorts are subtracted. When the resulting number is greater than 0 this number of escorts is added as escort with the function '''setUpEscorts''' and the '''escortsAreSetup''' flag is set.
 ==Adding with setUpEscorts==