games.spiders

Class AI

java.lang.Object

joueur.BaseAI

games.spiders.AI

public class AI
extends joueur.BaseAI

This is where you build your AI for the Spiders game.

Field Summary

Fields

Modifier and Type	Field and Description
Game	game This is the Game object itself, it contains all the information about the current game
Player	player This is your AI's player.

Constructor Summary

Constructors

Constructor and Description
AI()

Method Summary

Modifier and Type	Method and Description
void	ended(boolean won, java.lang.String reason) This is automatically called when the game ends.
void	gameUpdated() This is automatically called every time the game (or anything in it) updates.
java.lang.String	getName() This returns your AI's name to the game server.
java.lang.String	getSetting(java.lang.String key) Gets an AI setting passed to the program via the `--aiSettings` flag.
boolean	runTurn() This is called every time it is this AI.player's turn.
void	start() This is automatically called when the game first starts, once the Game object and all GameObjects have been initialized, but before any players do anything.

Methods inherited from class joueur.BaseAI

doOrder, invalid, setSettings

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

game

public Game game

This is the Game object itself, it contains all the information about the current game

player

public Player player

This is your AI's player. This AI class is not a player, but it should command this Player.

Constructor Detail

AI

public AI()

Method Detail

getName

public java.lang.String getName()

This returns your AI's name to the game server. Just replace the string.

Overrides:

getName in class joueur.BaseAI

Returns:

string of you AI's name

start

public void start()

This is automatically called when the game first starts, once the Game object and all GameObjects have been initialized, but before any players do anything. This is a good place to initialize any variables you add to your AI, or start tracking game objects.

Overrides:

start in class joueur.BaseAI

gameUpdated

public void gameUpdated()

This is automatically called every time the game (or anything in it) updates. If a function you call triggers an update this will be called before that function returns.

Overrides:

gameUpdated in class joueur.BaseAI

ended

public void ended(boolean won,
                  java.lang.String reason)

This is automatically called when the game ends. You can do any cleanup of you AI here, or do custom logging. After this function returns the application will close.

Overrides:

ended in class joueur.BaseAI

Parameters:

won - true if your player won, false otherwise

reason - a string explaining why you won or lost

runTurn

public boolean runTurn()

This is called every time it is this AI.player's turn.

Returns:

Represents if you want to end your turn. True means end your turn, False means to keep your turn going and re-call this function.

getSetting

public java.lang.String getSetting(java.lang.String key)

Gets an AI setting passed to the program via the `--aiSettings` flag. If the flag was set it will be returned as a string value, null otherwise.

Overrides:

getSetting in class joueur.BaseAI

Parameters:

key - The key of the setting you wish to get the value for

Returns:

A string representing the value set via command line, or null if the key was not set