core.player

Class Player

java.lang.Object

core.player.Player

Direct Known Subclasses:

AbstractMultiPlayer, AbstractPlayer, LearningPlayer

public abstract class Player
extends java.lang.Object

Created by Raluca on 07-Apr-16.

Constructor Summary

Constructors

Constructor and Description
Player()

Method Summary

Modifier and Type	Method and Description
abstract Types.ACTIONS	act(StateObservation stateObs, ElapsedCpuTimer elapsedTimer) Picks an action.
abstract Types.ACTIONS	act(StateObservationMulti stateObs, ElapsedCpuTimer elapsedTimer) Picks an action.
void	draw(java.awt.Graphics2D g) Gets the player the control to draw something on the screen.
java.util.ArrayList<Types.ACTIONS>	getAllActions() Get the history of actions of this player.
Types.ACTIONS	getLastAction() Gets the last action executed by this controller.
int	getPlayerID()
boolean	isHuman() Indicates if this player is human controlled.
void	logAction(Types.ACTIONS action) Logs a single action
void	result(StateObservation stateObs, ElapsedCpuTimer elapsedCpuTimer) Function called when the game is over.
void	resultMulti(StateObservationMulti stateObs, ElapsedCpuTimer elapsedCpuTimer)
void	setPlayerID(int id) Set the ID of this player.
void	setup(java.lang.String actionFile, int randomSeed, boolean isHuman) This function sets up the controller to save the actions executed in a given game.
void	teardown(Game played) Closes the agent, writing actions to file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Player

public Player()

Method Detail

act

public abstract Types.ACTIONS act(StateObservation stateObs,
                                  ElapsedCpuTimer elapsedTimer)

Picks an action. This function is called every game step to request an action from the player. The action returned must be contained in the actions accessible from stateObs.getAvailableActions(), or no action will be applied. Single Player method.

Parameters:

stateObs - Observation of the current state.

elapsedTimer - Timer when the action returned is due.

Returns:

An action for the current state

act

public abstract Types.ACTIONS act(StateObservationMulti stateObs,
                                  ElapsedCpuTimer elapsedTimer)

Picks an action. This function is called every game step to request an action from the player. The action returned must be contained in the actions accessible from stateObs.getAvailableActions(), or no action will be applied. Multi player method.

Parameters:

stateObs - Observation of the current state.

elapsedTimer - Timer when the action returned is due.

Returns:

An action for the current state

result

public void result(StateObservation stateObs,
                   ElapsedCpuTimer elapsedCpuTimer)

Function called when the game is over. This method must finish before CompetitionParameters.TEAR_DOWN_TIME, or the agent will be DISQUALIFIED

Parameters:

stateObs - the game state at the end of the game

elapsedCpuTimer - timer when this method is meant to finish.

resultMulti

public void resultMulti(StateObservationMulti stateObs,
                        ElapsedCpuTimer elapsedCpuTimer)

setup

public void setup(java.lang.String actionFile,
                  int randomSeed,
                  boolean isHuman)

This function sets up the controller to save the actions executed in a given game.

Parameters:

actionFile - file to save the actions to.

randomSeed - Seed for the sampleRandom generator of the game to be played.

isHuman - Indicates if the player is a human or not.

teardown

public final void teardown(Game played)

Closes the agent, writing actions to file.

logAction

public final void logAction(Types.ACTIONS action)

Logs a single action

Parameters:

action - the action to log.

getLastAction

public Types.ACTIONS getLastAction()

Gets the last action executed by this controller.

Returns:

the last action

isHuman

public boolean isHuman()

Indicates if this player is human controlled.

Returns:

true if the player is human.

getPlayerID

public int getPlayerID()

Returns:

the ID of this player

setPlayerID

public void setPlayerID(int id)

Set the ID of this player.

Parameters:

id - - the player's ID

getAllActions

public java.util.ArrayList<Types.ACTIONS> getAllActions()

Get the history of actions of this player.

Returns:

arrayList of all actions

draw

public void draw(java.awt.Graphics2D g)

Gets the player the control to draw something on the screen. It can be used for debug purposes.

Parameters:

g - Graphics device to draw to.