robocode.control.events

Class BattleStartedEvent


public class BattleStartedEvent
extends BattleEvent

A BattleStartedEvent is sent to onBattleStarted() when a new battle is started.
Authors:
Pavel Savara (original)
Flemming N. Larsen (contributor)
Since:
1.6.2
See Also:
IBattleListener, BattleCompletedEvent, BattleFinishedEvent

Constructor Summary

BattleStartedEvent(BattleRules battleRules, int robotsCount, boolean isReplay)
Creates a new BattleStartedEvent.

Method Summary

BattleRules
getBattleRules()
Returns the rules that will be used in the battle.
int
getRobotsCount()
Returns the number of robots participating in the battle.
boolean
isReplay()
Checks if this battle is a replay or real battle.

Constructor Details

BattleStartedEvent

public BattleStartedEvent(BattleRules battleRules,
                          int robotsCount,
                          boolean isReplay)
Creates a new BattleStartedEvent.
Parameters:
battleRules - the rules that will be used in the battle.
robotsCount - the number of robots participating in the battle.
isReplay - a flag specifying if this battle is a replay or real battle: true if the battle is a replay; false otherwise.

Method Details

getBattleRules

public BattleRules getBattleRules()
Returns the rules that will be used in the battle.
Returns:
the rules that will be used in the battle.

getRobotsCount

public int getRobotsCount()
Returns the number of robots participating in the battle.
Returns:
the number of robots participating in the battle.

isReplay

public boolean isReplay()
Checks if this battle is a replay or real battle.
Returns:
true if the battle is a replay; false otherwise.