robocode.control.events

Class BattleStartedEvent

java.lang.Object

robocode.control.events.BattleEvent

robocode.control.events.BattleStartedEvent

public class BattleStartedEvent
extends BattleEvent

A BattleStartedEvent is sent to onBattleStarted() when a new battle is started.

Since:

1.6.2

Author:

Pavel Savara (original), Flemming N. Larsen (contributor)

See Also:

IBattleListener, BattleCompletedEvent, BattleFinishedEvent

Constructor Summary

Constructors

Constructor and Description
BattleStartedEvent(BattleRules battleRules, int robotsCount, boolean isReplay) Called by the game to create a new BattleStartedEvent.

Method Summary

Modifier and Type	Method and Description
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 a new battle.

Methods inherited from class java.lang.Object

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

Constructor Detail

BattleStartedEvent

public BattleStartedEvent(BattleRules battleRules,
                          int robotsCount,
                          boolean isReplay)

Called by the game to create a new BattleStartedEvent. Please don't use this constructor as it might change.

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 Detail

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 a new battle.

Returns:

true if the battle is a replay; false otherwise.