Changes between Version 3 and Version 4 of AIEngineAPI

Timestamp:

Jul 19, 2012, 11:14:21 PM (12 years ago)

Author:

Jonathan Waller

Comment:

made formatting of objects consistent and added some information about the constructor

AIEngineAPI

@@ -5 +5 @@
 The Engine uses the AIInterface and AIProxy components to provide this data.  The AIInterface is a player level component which handles communication with the AI.  AIProxy is an entity level component which creates a proxy representation of each entity to be given to the AI.
 
-The AI's `HandleMessage` method is called with one argument:
+When the AI is initialised the constructor is called with one parameter:
+
+{{{#!js
+settings = {
+  "player": 1, // The player id.  Gaia is 0, players are number sequentially 1,...,n.
+  "templates": ..., // An object which gives access to the template data from .../simulation/templates/
+}}}
+
+Every AI turn (currently happens every simulation update which is 5 times a second) the AI's `HandleMessage` method is called with one argument:
 
 {{{#!js
 state = {
-  entities: ...,
-  events: ...,
-  players: [...],
-  timeElapsed: ..., // seconds since the start of the match
-  territoryMap: ..., // map of player territories
-  passabilityMap: ..., // Map showing where obstructions are
-  passabilityClasses: ...
+  "entities": ...,
+  "events": ...,
+  "players": [...],
+  "timeElapsed": ..., // seconds since the start of the match
+  "territoryMap": ..., // map of player territories
+  "passabilityMap": ..., // Map showing where obstructions are
+  "passabilityClasses": ...
 }}}
 == `entities` ==
@@ -57 +65 @@
 {{{#!js
 state.passabilityMap = {
-  width: 256,
-  height: 256,
-  data: [ ... ] // Uint16Array with width*height entries
+  "width": 256,
+  "height": 256,
+  "data": [ ... ] // Uint16Array with width*height entries
 };
 }}}