Package ai.nettogrof.battlesnake.snakes

Class AbstractSnakeAI

  • Direct Known Subclasses:
    AbstractSearchSnakeAI, AbstractSimpleSnakeAI
    public abstract class AbstractSnakeAI
extends Object
    Any snake should extend this abstract class it contains basic constant fields, related to the field name in json call from BattleSnake. Also some method that any snake must implements.
    Version:
    Spring 2021
    Author:
    carl.lajeunesse

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int apiversion
      API version use, some snakes are able to play both version v0 and v1.
      protected static String BOARD
      Constant Field name
      protected static String BODY
      Constant Field name
      protected static String DOWN
      Constant Field name
      protected String fileConfig
      Any snake must use a fileConfig (a properties files), and the name of the file must store in the string
      protected static int FOUR_SNAKE
      Constant Field name
      protected String gameId
      Snakes can play games in parallel, so the game id field is use to distinguish different game
      protected static String HEAD
      Constant Field name
      protected static String HEALTH
      Constant Field name
      protected int height
      Board height
      protected static String HEIGHT_FIELD
      Constant Field name
      protected static String LEFT
      Constant Field name
      protected static com.google.common.flogger.FluentLogger log
      Basic logger object
      protected static String MOVESTR
      Constant Field name
      protected static String NAME
      Constant Field name
      protected static String RIGHT
      Constant Field name
      protected GameRuleset rules
      Game rulesset
      protected static String SHOUT
      Constant Field name
      protected static int SINGLE_SNAKE
      Constant Field name
      protected static String SNAKES
      Constant Field name
      protected static String SQUAD
      Constant Field name
      protected static String TURN
      Constant Field name
      protected static int TWO_SNAKE
      Constant Field name
      protected static String UPWARD
      Constant Field name
      protected int width
      Board width
      protected static String WIDTH_FIELD
      Constant Field name
      protected static String YOU
      Constant Field name

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractSnakeAI()
      Basic constructor not used
      protected AbstractSnakeAI​(String gameId)
      Constructor with the gameid,

    • Constructor Detail

      • AbstractSnakeAI

        protected AbstractSnakeAI()
        Basic constructor not used

      • AbstractSnakeAI

        protected AbstractSnakeAI​(String gameId)
        Constructor with the gameid,
        Parameters:
        gameId - String of the gameid field receive in the start request.

    • Method Detail

      • start

        public Map<String,​String> start​(com.fasterxml.jackson.databind.JsonNode startRequest)
        This method was used in API v0 to retrieve snake info, but in API v1 the method is call but Battlesnake doesn't need a response. This can be use to initialize your snake
        Parameters:
        startRequest - Json call received
        Returns:
        map that can be empty because it will be ignore by BattleSnake server

      • move

        public abstract Map<String,​String> move​(com.fasterxml.jackson.databind.JsonNode moveRequest)
        This method will be call on each move request receive by BattleSnake, so all snakes must implement it, and add game logic in it
        Parameters:
        moveRequest - Json call received
        Returns:
        map of field to be return to battlesnake, example "move" , "up"

      • end

        public Map<String,​String> end​(com.fasterxml.jackson.databind.JsonNode endRequest)
        This method will be call at the end of the game, can be override if you want to clean-up some game info.
        Parameters:
        endRequest - Json call received
        Returns:
        map that can be empty because it will be ignore by BattleSnake server

      • ping

        public void ping()
        Method that was use in API v0 to check if the bots was up. in API v1 is not used anymore

      • getFileConfig

        protected abstract String getFileConfig()
        Gets the config file to set properties correctly
        Returns:
        the config filename

      • getInfo

        public Map<String,​String> getInfo()
        Return the infos need by Battlesnake when receive a (root GET /) request
        Returns:
        map of info for Battlesnake

      • setFileConfig

        public void setFileConfig​(String fileConfig)
        Set the file config filename
        Parameters:
        fileConfig - the fileConfig to set