aiinterface

Interface AIInterface

public interface AIInterface

The interface that defines the methods to implement in AI.

Method Summary

Modifier and Type	Method and Description
void	close() Finalizes AI. It runs only once at the end of each game.
default void	getAudioData(AudioData ad) Gets the audio information in each frame. For more details on the data structure, please see https://tinyurl.com/DareFightingICE/AI.
void	getInformation(FrameData fd)
default void	getInformation(FrameData fd, boolean isControl) Gets information from the game status in each frame.
default void	getScreenData(ScreenData sd) Gets the screen information in each frame.
int	initialize(GameData gd, boolean playerNumber) This method initializes AI, and it will be executed only once in the beginning of each game.
Key	input() Receives a key input from AI. It is executed in each frame and returns a value in the Key type.
void	processing() Processes the data from AI.
void	roundEnd(int p1Hp, int p2Hp, int frames) Informs the result of each round. It is called when each round ends.

Method Detail

initialize

int initialize(GameData gd,
               boolean playerNumber)

This method initializes AI, and it will be executed only once in the beginning of each game.
Its execution will load the data that cannot be changed and load the flag of the 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:

gd - the data that will not be changed during a game

playerNumber - the character's side flag.
true if the character is P1, or false if P2.

Returns:

0 when such initialization finishes correctly

See Also:

GameData

getInformation

default void getInformation(FrameData fd,
                            boolean isControl)

Gets information from the game status in each frame.
Such information is stored in the parameter frameData.
If frameData.getRemainingTime() 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.getEmptyFlag() && frameData.getRemainingTime() > 0 holds; otherwise, NullPointerException will occur.
You must also check the same condition when you use the CommandCenter class.

Parameters:

fd - the data that will be changed each frame

isControl - whether the character can act. this parameter is not delayed unlike CharacterData.isControl()

See Also:

FrameData

getInformation

void getInformation(FrameData fd)

processing

void processing()

Processes the data from AI.
It is executed in each frame.

input

Key input()

Receives a key input from AI.
It is executed in each frame and returns a value in the Key type.

Returns:

the value in the Key type

See Also:

Key

close

void close()

Finalizes AI.
It runs only once at the end of each game.

roundEnd

void roundEnd(int p1Hp,
              int p2Hp,
              int frames)

Informs the result of each round.
It is called when each round ends.

Parameters:

p1Hp - P1's remaining HP

p2Hp - P2's remaining HP

frames - the elapsed frames from the start to the end of the round

getScreenData

default void getScreenData(ScreenData sd)

Gets the screen information in each frame.

Parameters:

sd - the screen information such as the pixel data, it will be empty in blind mode.

getAudioData

default void getAudioData(AudioData ad)

Gets the audio information in each frame.
For more details on the data structure, please see https://tinyurl.com/DareFightingICE/AI.

Parameters:

ad - the audio information.