bot.closure.template.js

function createExamplePlayer() {

  /**
   * OPTIONAL method / lifecycle hook.
   * Called by the framework to notify Player the start of the Match, providing the rules for the Match
   *
   * Parameters:
   *   matchRules - { rounds: <numberOfRoundsInMatch> }
   */
  function onMatchStart(matchRules) {}

  /**
   * OPTIONAL method / lifecycle hook.
   * Called by the framework to notify Player the start of the Match, providing the rules for the Match
   *
   * Parameters:
   *   matchRules - { rounds: <numberOfRoundsInMatch> }
   */
  function onMatchStart(matchRules) {}

  /**
   * OPTIONAL method / lifecycle hook.
   * Called by the framework to notify Player of the start of a Round, providing the rules for the Round
   *
   * Parameters:
   *   roundRules - {
   *     turns: <maxNumberOfTurnsInRound>,
   *     defenderBonus: <amountOfBonusAttackPowerWhenDefending>
   *   }
   */
  function onRoundStart(roundRules) {}

  /**
   * REQUIRED method!
   * Called by the framework to solicit the Player's actions each turn, providing the Player's current state.
   * This is the only mechanism by which the Player is able to communicate with the Game.
   *
   * Parameters:
   *   playerState - {
   *     producers: <currentProducerCount>,
   *     soldiers: <currentSoldierCount>
   *   }
   *
   * Expected Return Value: PlayerActions
   *   {
   *     newProducers: <numberOfNewProducersToProduce>,
   *     newSoldiers: <numberOfNewSoldiersToProduce>,
   *     launchAttack: <true | false -- set to true to launch attack with your soldiers at end of turn>
   *   }
   */
  function playTurn(playerState) {
    return {
      newProducers: 0,
      newSoldiers: 0,
      launchAttack: false
    };
  }

  /**
   * OPTIONAL method.
   * Called by the framework to notify Player of the end of a Round, providing the results of the round.
   *
   * Parameters:
   *   roundResult - {
   *     outcome: <'WIN' | 'LOSS' | 'DRAW'>,
   *     turnsPlayed: <numberOfTurnsPlayedInRound>,
   *     you: {
   *       producers: <yourProducerCountAtEndOfRound>,
   *       soldiers: <yourSoldierCountAtEndOfRound>,
   *       attackLaunched: <true | false -- true if you launched attack on last turn>
   *     },
   *     them: {
   *       producers: <theirProducerCountAtEndOfRound>,
   *       soldiers: <theirSoldierCountAtEndOfRound>,
   *       attackLaunched: <true | false -- true if they launched attack on last turn>
   *     }
   *   }
   */
  function onRoundEnd(roundResult) { }


  // Finally, return your Player object here. Don't forget to set metadata :-)
  return {
    meta: {
      name: 'Name of Your Bot',
      author: 'Your Name'
    },
    onMatchStart, // Optional
    onRoundStart, // Optional
    playTurn,
    onRoundEnd // Optional
  };
}

export default createExamplePlayer;