Merge pull request #76 from Itangalo/1.3

1.3

Author: Itangalo

000-simulation.gs

@@ -11,11 +11,11 @@
  */
 
 // Initiate some global variables.
-var global = {}; // Further populated by buildInitialData().
+var BPTstatic = {}; // Further populated by buildInitialData().
 var modules = {}; // Populated by custom code.
 var module;
 var gameState = {};
-global.startTime = Date.now();
+BPTstatic.startTime = Date.now();
 
 function simulate(iterations = false, mod = false) {
   // Set global default values.
@@ -35,7 +35,7 @@ function simulate(iterations = false, mod = false) {
    */
   let results = []; // Variable used to save data from each game iteration.
   if (!iterations)
-    iterations = global.defaults.iterations;
+    iterations = BPTstatic.defaults.iterations;
   for (let iteration = 1; iteration <= iterations; iteration++) {
     /**
      * Set up each game.

003-defaults.gs

@@ -3,7 +3,7 @@
  */
 
 function setInitialDefaults() {
-  global.defaults = {
+  BPTstatic.defaults = {
     module: 'example1',
     iterations: 100,
     logging : {
@@ -49,7 +49,7 @@ function setInitialDefaults() {
     },
   };
   // Apply some defaults right away.
-  module = global.defaults.module;
+  module = BPTstatic.defaults.module;
   for (let i of ['logging', 'statistics'])
-    global[i] = global.defaults[i];
+    BPTstatic[i] = BPTstatic.defaults[i];
 }

200-helpersGeneral.gs

@@ -298,14 +298,25 @@ function copy(object) {
   return JSON.parse(JSON.stringify(object));
 }
 
-// Checks if an object/array is iterable.
-// Code from https://stackoverflow.com/questions/18884249/checking-whether-something-is-iterable
-function isIterable(obj) {
-  // checks for null and undefined
-  if (obj == null) {
-    return false;
+/**
+ * Stores an object in the cache, to use in future game iterations. Identified by 'key'.
+ */
+function setCache(key, value) {
+  if (!BPTstatic.cache)
+    BPTstatic.cache = {};
+  BPTstatic.cache[key] = value;
+}
+
+/**
+ * Returns a cached object, identified by 'key', or undefined if it is not cached.
+ * Cached objects are kept between game iterations.
+ */
+function getCache(key) {
+  if (!BPTstatic.cache) {
+    BPTstatic.cache = {};
+    return undefined;
   }
-  return typeof obj[Symbol.iterator] === 'function';
+  return BPTstatic.cache[key];
 }
 
 // Returns the agent with the matching id or false if none is found.
@@ -315,6 +326,36 @@ function getAgentById(id) {
   return new ObjectFilter({id: id}).findFirstInArray(gameState.agents);
 }
 
+/**
+ * Returns the first agent in the list of agents, and moves it last in the list.
+ */
+function getAndRotateFirstAgent() {
+  let agent = gameState.agents[0];
+  gameState.agents.shift();
+  gameState.agents.push(agent);
+  return agent;
+}
+
+// Returns an array of tracked data for the given property. Adds zeroes when needed.
+function getTrackedData(property) {
+  let output = [];
+  for (let a of gameState.agents) {
+    if (!a.tracking || !a.tracking[property])
+      output.push({
+        increaseCount: 0,
+        increaseSum: 0,
+        decreaseCount: 0,
+        decreaseSum: 0,
+        unchangedCount: 0,
+        count: 0,
+        sum: 0,
+      });
+    else
+      output.push(a.tracking[property]);
+  }
+  return output;
+}
+
 // Selects a and returns a random element from an array. If the array consists of
 // objects, 'property' can be set to a property name in order to use the property
 // values for weighting probability.
@@ -468,5 +509,5 @@ function callResolver(method) {
     return false;
   }
 
-  return modules[module].resolvers[type][method](...parseArguments(arguments, 1));
+  return modules[module].resolvers[method](...parseArguments(arguments, 1));
 }

210-processResults.gs

@@ -31,7 +31,7 @@ function processResults(results) {
   // Header row
   let message = 'DISTRIBUTION: average (percentile ';
   let values = [];
-  for (let p of global.statistics.percentiles) {
+  for (let p of BPTstatic.statistics.percentiles) {
     values.push(p);
   }
   message += values.join(' | ') + ')\r\n---\r\n';
@@ -40,7 +40,7 @@ function processResults(results) {
     message += i + ': ';
     message += average(sortedResults[i]).toFixed(2) + ' (';
     values = [];
-    for (let p of global.statistics.percentiles) {
+    for (let p of BPTstatic.statistics.percentiles) {
       values.push(percentile(sortedResults[i], p).toFixed(2));
     }
     message += values.join(' | ') + ') Positive at ';
@@ -67,7 +67,7 @@ function processResults(results) {
     output[2].push(getPositiveThreshold(sortedResults[i]));
   }
   // Percentiles
-  for (let p of global.statistics.percentiles) {
+  for (let p of BPTstatic.statistics.percentiles) {
     let line = ['percentile ' + p];
     for (let i in sortedResults) {
       line.push(percentile(sortedResults[i], p));

220-logging.gs

@@ -9,9 +9,9 @@
  * @param {string} type: The type of log message, used for restricting actual output.
  */
 function log(message, type) {
-  if (global.logging.categories[type]) {
-    if (global.logging.showTimestamps)
-      message += ' (time: ' + (Date.now() - global.startTime) + ')';
+  if (BPTstatic.logging.categories[type]) {
+    if (BPTstatic.logging.showTimestamps)
+      message += ' (time: ' + (Date.now() - BPTstatic.startTime) + ')';
     Logger.log(message);
   }
 }

classes/100-Agent.gs

@@ -81,6 +81,32 @@ class Agent {
     }
   }
 
+  /**
+   * Returns a randomly selected agent other than this agent.
+   * 
+   * @param {ObjectFilter} filter: If used, any additional restrictions will be applied.
+   */
+  getRandomOpponent(filter = false) {
+    if (filter === false)
+      filter = new ObjectFilter().addNotEqualsCondition({id: this.id});
+    else
+      filter.addNotEqualsCondition({id: this.id});
+    
+    let candidates = filter.applyOnArray(gameState.agents);
+    if (candidates.length == 0)
+      throw('Tried to select a random opponent, but found no matching agents.');
+
+    return selectRandom(candidates);
+  }
+
+  /**
+   * Places the agent first in the list of agents.
+   */
+  makeFirstAgent() {
+    let a = new ObjectFilter({id: this.id}).removeFirstFromArray(gameState.agents);
+    gameState.agents.unshift(a);
+  }
+
   /**
    * Used to call a strategy on behalf of the agent. Any arguments will be passed on
    * to the strategy method. First argument will always be the agent object.
@@ -99,6 +125,7 @@ class Agent {
     if (!modules[module].agentStrategies[this.strategy][method])
       throw('Method ' + method + ' does not exist in ' + this.strategy + '.');
 
-    return modules[module].agentStrategies[this.strategy][method](this, ...arguments);
+    let args = parseArguments(arguments, 1);
+    return modules[module].agentStrategies[this.strategy][method](this, ...args);
   }
 }

classes/110-Deck.gs

@@ -20,7 +20,7 @@ class Deck {
    */
   constructor(deckData, cardDataArray = false) {
     // Add default settings, overwrite with provided data.
-    Object.assign(this, applyDefaults(global.defaults.deck, deckData));
+    Object.assign(this, applyDefaults(BPTstatic.defaults.deck, deckData));
     // Verify that an ID is present.
     Object.assign(this, deckData);
     if (this.id === undefined)

classes/120-Track.gs

@@ -14,6 +14,8 @@
  *    - gridMovement: If true, possible movement is defined through connections on spaces. Defaults to false.
  *    - symmetricConnections: If true, any connections between spaces are assumed to go both ways.
  *      Only relevant if gridMovement is true. Defaults to true.
+ *    - cacheGraph: If true, the created map of connections between spaces is stored between game iterations.
+ *      Only use if the connections do not change within or between games. Defaults to false.
  *
  * @param {Array} spacesDataArray: An array of objects describing each space on the track.
  * See Space class for details.
@@ -23,7 +25,7 @@
 class Track {
   constructor(trackData, spacesDataArray = false, pawnsDataArray = false) {
     // Add default settings, overwrite with provided data.
-    Object.assign(this, applyDefaults(global.defaults.track, trackData));
+    Object.assign(this, applyDefaults(BPTstatic.defaults.track, trackData));
     // Verify that an ID is present.
     if (this.id === undefined)
       throw('Tracks must have an id property set.');
@@ -60,19 +62,29 @@ class Track {
     // Build a graph of how the spaces connect, if advanced movement is used.
     // Data used by the a-star algorithm, to find paths in the grid.
     if (this.gridMovement) {
-      this.graph = [];
-      for (let i = 0; i < this.spaces.length; i++)
-        this.graph.push([]);
-      for (let s of this.spaces) {
-        for (let c of s.connectsTo) {
-          let target = new ObjectFilter({id: c}).findFirstInArray(this.spaces);
-          this.graph[s.index][target.index] = 1;
-          if (this.symmetricConnections)
-            this.graph[target.index][s.index] = 1;
+      if (this.cacheGraph) {
+        this.graph = getCache('track.' + this.id + '.grid');
+        this.heuristic = getCache('track.' + this.id + '.heuristic');
+      }
+      else
+        this.graph = false;
+      if (!this.graph) {
+        this.graph = [];
+        for (let i = 0; i < this.spaces.length; i++)
+          this.graph.push([]);
+        for (let s of this.spaces) {
+          for (let c of s.connectsTo) {
+            let target = new ObjectFilter({id: c}).findFirstInArray(this.spaces);
+            this.graph[s.index][target.index] = 1;
+            if (this.symmetricConnections)
+              this.graph[target.index][s.index] = 1;
+          }
         }
+        let row = Array(this.graph.length).fill(1);
+        this.heuristic = Array(this.graph.length).fill(row);
+        setCache('track.' + this.id + '.grid', this.graph);
+        setCache('track.' + this.id + '.heuristic', this.heuristic);
       }
-      let row = Array(this.graph.length).fill(1);
-      this.heuristic = Array(this.graph.length).fill(row);
       this.pawnPaths = {};
     }
 
@@ -138,7 +150,7 @@ class Track {
       if (this.assumePresent) {
         return new Pawn({id: pawnId}, this);
       }
-      if (global.debugRunning)
+      if (BPTstatic.debugRunning)
         return false;
       throw('Tried to get pawn ' + pawnId + ' but no such pawn exist on track + ' + this.id + '.');
     }

classes/130-Market.gs

@@ -32,7 +32,7 @@
 class Market {
   constructor(marketData, goodsDataArray = false) {
     // Add default settings, overwrite with provided data.
-    Object.assign(this, applyDefaults(global.defaults.market, marketData));
+    Object.assign(this, applyDefaults(BPTstatic.defaults.market, marketData));
     // Verify that an ID is present.
     if (this.id === undefined)
       throw('Markets must have an id property set.');
@@ -302,7 +302,7 @@ class Goods {
     if (!market instanceof Market)
       throw('Goods must be added to a proper market.');
     // Add default settings, overwrite with provided data.
-    Object.assign(this, applyDefaults(global.defaults.goods, goodsData));
+    Object.assign(this, applyDefaults(BPTstatic.defaults.goods, goodsData));
 
     if (this.id === undefined)
       throw('Goods must have an id property set.');

classes/140-DiceRoll.gs

@@ -4,7 +4,7 @@
 class DiceRoll {
   constructor(quantity = false, numberOfSides = false, customSides = false) {
     // Add default settings, then override by any provided arguments.
-    Object.assign(this, global.defaults.diceRoll);
+    Object.assign(this, BPTstatic.defaults.diceRoll);
     if (quantity) this.quantity = quantity;
     if (numberOfSides) this.numberOfSides = numberOfSides;
     if (customSides) this.customSides = customSides;