OXP howto AI - Revision history

Milo: added notice about new OXP standards recommending use of Priority AI over plist-based AI, with links

2020-06-20T03:50:40Z

added notice about new OXP standards recommending use of Priority AI over plist-based AI, with links

2013-07-04T17:04:29Z

‎Perform Action: performBroadside removed (only in 1.77, testing command)

2013-01-22T07:46:09Z

‎Perform Action: Don't forget the constant in dealEnergyDamageWithin...

2013-01-21T20:47:35Z

Updated broadcastDistressMessage

2012-08-18T09:38:20Z

‎Perform Action: scripted AI

2012-08-05T14:01:05Z

‎Perform Action: version note

2012-08-04T11:08:34Z

‎Communication: Document ATTACKED (and ATTACKER_MISSED for 1.77)

2012-06-10T09:14:00Z

‎Perform Action: performBroadside

2012-06-06T14:24:25Z

linked to Oolite_JavaScript_Reference:_Entity

2012-05-20T15:54:23Z

‎Perform Action: Cascade weapon commands

← Older revision		Revision as of 03:50, 20 June 2020
Line 1:		Line 1:
		+	'''Notice'''
		+
		+	This page describes the plist-based method of AI scripting in Oolite. [[OXP standards\|Since version 1.80]], the use of plist-based AIs for non-trivial AIs is '''discouraged'''. Javascript AIs are '''recommended'''. Use of the [[Oolite Javascript Reference: PriorityAI Documentation\|Priority AI library]] to write AIs, especially the standard conditions and behaviours it provides, is useful to make ships fit in with the core ships and to have future improvements to AI incorporated easily. Alternative AI controller libraries released as OXPs may also be used.
		+
	'''AI Script Format'''		'''AI Script Format'''

@@ Line 180: / Line 180: @@
 |'''performAvoidCollision'''
 |This is not an existing AI command but only added here to show its existence that can interfere with other perform actions. Its an automatic feature used by several of the other perform commands to avoid a collision with a very nearby object. The old performance is temporary put on ice, the ships moves away a bit from the obstacle and than continues the old performance. This automatic collision avoidance can be a problem when you want to navigate a ship very close to an existing ship. Therefore none of the non-battle performances will avoid collision with a primary target.
 |-
 |'''performCollect'''

@@ Line 102: / Line 102: @@
 |-
 |'''dealEnergyDamageWithinDesiredRange'''
-|Needs desiredRange to be set first, then deals energy damage to ships within this sphere, based on [[Shipdata.plist#weapon_energy|weapon_energy]]:   (weapon_energy * desiredRange) / (distance * distance)
+|Needs desiredRange to be set first, then deals energy damage to ships within this sphere, based on [[Shipdata.plist#weapon_energy|weapon_energy]]:   (weapon_energy * desiredRange) / (6.76 * distance * distance)
 |-
 |'''decreaseAlertLevel'''

@@ Line 411: / Line 411: @@
 |-
 |'''broadcastDistressMessage'''
-|Locates all the stations, bounty hunters and police ships in range and tells them that you are under attack. This command resets a previous found target to none at the sending side. It returns: "'''ACCEPT_DISTRESS_MESSAGE'''" in the AI of Stations, Hunters and Police ships and gives them as" Found Target", the "Primary Target" of the sender of the broadcast.
+|When a primary aggressor exist, this command locates all the stations, bounty hunters and police ships in range and tells them that you are under attack. This command resets a previous found target to none at the sending side. It returns: "'''ACCEPT_DISTRESS_MESSAGE'''" in the AI of Stations, Hunters and Police ships and gives them as" Found Target", the "Primary Target" of the sender of the broadcast.
 |-
 |'''commsMessage:(NSString *)valueString'''

@@ Line 227: / Line 227: @@
 |'''performMining'''
 |Performs mining. (Finds, intercepts and shoots asteroids with [[mining]] laser, if fitted.) It returns: "'''TARGET_LOST'''".
 |-
 |'''performTumble'''
-|Performs random pitch and roll, 'evasive maneuvers'.
+|Performs random pitch and roll, 'evasive manoeuvres'.
 |-
 |'''setSpeedFactorTo:(NSString *)speedString'''
-|Sets the desired speed to a percentage of maxspeed (0->1=0%->100%). If speedfactor is set above 100%, entity will use fuelinjectors if available.
+|Sets the desired speed to a percentage of maxspeed (0->1=0%->100%). If speedfactor is set above 100%, entity will use fuel injectors if available.
 |-
 |'''setSpeedTo:(NSString *)speedString'''

@@ Line 98: / Line 98: @@
 |Used at player entity death, not for use in other instances.
 |-
-|'''broadcastEnergyBlastImminent'''
+|'''broadcastEnergyBlastImminent'''<br>(1.77 or later)
 |Used in the [[Q bomb]]. Sends a CASCADE_WEAPON_DETECTED event to every ship in scanner range.
 |-

@@ Line 393: / Line 393: @@
 !width="225"|Method
 !Description
 |-
 |'''******'''

@@ Line 1: / Line 1: @@
 '''AI Script Format'''
-The AI system consists of a [[Stacked AI|stack]] of [[state machine]]s (only the top one of which is active), which respond to game events sent to them as [[Messages|messages]]. They respond by calling a series of [[methods]] which affect the behaviour of the [[entity]] and possibly trigger changes to the '''AI''' by changing the [[state]] or (more drastically) the state machine.
+The AI system consists of a [[Stacked AI|stack]] of [[state machine]]s (only the top one of which is active), which respond to game events sent to them as [[Messages|messages]]. They respond by calling a series of [[methods]] which affect the behaviour of the [[Oolite_JavaScript_Reference:_Entity|Entity]] and possibly trigger changes to the '''AI''' by changing the state or (more drastically) the state machine.
 Each state machine (or AI script) is described in a [[property list]]. The structure is of a dictionary containing each of the machine's possible states referenced by an identifying state name. Each state comprises a dictionary of responses to messages the AI might receive, referenced by the message itself. Each response is an array of methods that will be called when the AI receives that message.

@@ Line 90: / Line 90: @@
 |-
 |'''becomeEnergyBlast'''
-|Used in the [[Q bomb]].
+|Used in the [[Q bomb]]. Sends a CASCADE_WEAPON_DETECTED event to every ship in scanner range.
 |-
 |'''becomeExplosion'''
@@ Line 97: / Line 97: @@
 |'''becomeLargeExplosion'''
 |Used at player entity death, not for use in other instances.
 |-
 |'''dealEnergyDamageWithinDesiredRange'''