gameInterface

Interface AIInterface

public interface AIInterface

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This method finalizes AI.
void	getInformation(FrameData frameData) This method gets information from the game status in each frame.
int	initialize(GameData gameData, boolean playerNumber) This method initializes AI, and it will be executed only once in the beginning of a game.
Key	input() The input method receives key inputting from AI.
void	processing() This method processes the data from AI.

Method Detail

initialize

int initialize(GameData gameData,
             boolean playerNumber)

This method initializes AI, and it will be executed only once in the beginning of a game. Its execution will load the data that cannot be changed and load the flag of player's side ("Boolean player", true for P1 or false for P2). If there is anything that needs to be initialized, you had better do it in this method. It will return 0 when such initialization finishes correctly, otherwise the error code.

Parameters:

gameData - data that will not be changed during a game

playerNumber - playerNumber of self

Returns:

0 when such initialization finishes correctly, otherwise the error code

See Also:

GameData

getInformation

void getInformation(FrameData frameData)

This method gets information from the game status in each frame. Such information is stored in the argument fd. If fd.getRematingTime() returns a negative value, the current round has not started yet. When you use frameData received from getInformation(), you must always check if the condition "!frameData.emptyFlag && frameData.getRemainingTime() > 0" holds; otherwise, NullPointerException will occur. You must also check the same condition when you use the CommandCenter class.

Parameters:

frameData - data that will be changed each frame

See Also:

FrameData

processing

void processing()

This method processes the data from AI. It is executed in each frame

input

Key input()

The input method receives key inputting from AI. It is executed in each frame and returns a value in the Key type.

Returns:

Key

See Also:

Key

close

void close()

This method finalizes AI. It runs only once at the end of each game.