org.gjt.universe
Class ResultColonize

java.lang.Object
  |
  +--org.gjt.universe.ResultBase
        |
        +--org.gjt.universe.ResultColonize

All Implemented Interfaces:

java.io.Serializable

public final class ResultColonize

extends ResultBase

An object encapsulating information about the result of sending a colony ship to a colonizable location. This is intended for eventual communication to a human or AI civ. Normally a colonizable location will be a planet's surface. However, other locations may also be colonizable depending on the species on-board the ship and the technology of the sending civilization.

See Also:

Serialized Form

Field Summary

private CivID	AID
private FleetID	FID
private PlanetID	PID

Fields inherited from class org.gjt.universe.ResultBase

Constructor Summary

private

ResultColonize(CivID AID, FleetID FID, PlanetID PID)

Method Summary

static void	newResult(CivID AID, FleetID FID, PlanetID PID) Contructior for a new colonization result instance.
void	selected() This concrete implementation of the selected method causes a new instance of the planet specific GUI to be shown for the colony planet (filtered using the civ's limitations on knowledge).

Methods inherited from class org.gjt.universe.ResultBase

getDisplayReturn, setDisplayReturn

Methods inherited from class java.lang.Object

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

Field Detail

FID

private FleetID FID

PID

private PlanetID PID

AID

private CivID AID

Constructor Detail

ResultColonize

private ResultColonize(CivID AID,
                       FleetID FID,
                       PlanetID PID)

Method Detail

newResult

public static void newResult(CivID AID,
                             FleetID FID,
                             PlanetID PID)

Contructior for a new colonization result instance.

Parameters:

AID - The ID of the civ for whom the result is being generated

FID - The ID of the fleet which contained the colony ship.

PID - The ID of the planet on or around which the colonization occurred.

selected

public void selected()

This concrete implementation of the selected method causes a new instance of the planet specific GUI to be shown for the colony planet (filtered using the civ's limitations on knowledge).

Specified by:

selected in class ResultBase