Package megamek.common.event

Class GameVictoryEvent

java.lang.Object

java.util.EventObject

megamek.common.event.GameEvent

megamek.common.event.GameVictoryEvent

All Implemented Interfaces:

Serializable, PostGameResolution

public class GameVictoryEvent
extends GameEvent
implements PostGameResolution

An event that is fired at the end of the victory phase, before the game state is reset. It can be used to retrieve information from the game before the state is reset and the lounge phase begins.

See Also:

• Game.end(int, int)
• GameListener
• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
GameVictoryEvent(Object source, Game game)

Method Summary

Modifier and Type	Method	Description
void	fireEvent(GameListener gl)	Sub-classed events implement this method to call their specific method on a GameListener instance that their event has been fired.
Enumeration<Entity>	getDevastatedEntities()	Returns an enumeration of entities that were utterly destroyed
Enumeration<Entity>	getEntities()
Entity	getEntity(int id)
String	getEventName()
Enumeration<Entity>	getGraveyardEntities()
Enumeration<Entity>	getRetreatedEntities()	Returns an enumeration of entities that have retreated
Enumeration<Entity>	getWreckedEntities()

Methods inherited from class megamek.common.event.GameEvent

toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Details

GameVictoryEvent

public GameVictoryEvent(Object source,
 Game game)

Parameters:

source - event source

Method Details

fireEvent

public void fireEvent(GameListener gl)

Description copied from class: GameEvent

Sub-classed events implement this method to call their specific method on a GameListener instance that their event has been fired.

Specified by:

fireEvent in class GameEvent

Parameters:

gl - GameListener recipient.

getEventName

public String getEventName()

Specified by:

getEventName in class GameEvent

getEntities

public Enumeration<Entity> getEntities()

Specified by:

getEntities in interface PostGameResolution

Returns:

an enumeration of all the entities in the game.

getEntity

public Entity getEntity(int id)

Specified by:

getEntity in interface PostGameResolution

Returns:

the entity with the given id number, if any.

getGraveyardEntities

public Enumeration<Entity> getGraveyardEntities()

Specified by:

getGraveyardEntities in interface PostGameResolution

Returns:

an enumeration of salvageable entities.

getWreckedEntities

public Enumeration<Entity> getWreckedEntities()

Specified by:

getWreckedEntities in interface PostGameResolution

Returns:

an enumeration of wrecked entities.

getRetreatedEntities

public Enumeration<Entity> getRetreatedEntities()

Returns an enumeration of entities that have retreated

Specified by:

getRetreatedEntities in interface PostGameResolution

getDevastatedEntities

public Enumeration<Entity> getDevastatedEntities()

Returns an enumeration of entities that were utterly destroyed

Specified by:

getDevastatedEntities in interface PostGameResolution