games.catastrophe

Class Unit

java.lang.Object

joueur.BaseGameObject

games.catastrophe.GameObject

games.catastrophe.Unit

public class Unit
extends GameObject

A unit in the game.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	acted Whether this Unit has performed its action this turn.
double	energy The amount of energy this Unit has (from 0.0 to 100.0).
int	food The amount of food this Unit is holding.
Job	job The Job this Unit was recruited to do.
int	materials The amount of materials this Unit is holding.
Tile	movementTarget The tile this Unit is moving to.
int	moves How many moves this Unit has left this turn.
Player	owner The Player that owns and can control this Unit, or null if the Unit is neutral.
java.util.List<Unit>	squad The Units in the same squad as this Unit.
boolean	starving Whether this Unit is starving.
Tile	tile The Tile this Unit is on.
int	turnsToDie The number of turns before this Unit dies.

Fields inherited from class games.catastrophe.GameObject

logs

Fields inherited from class joueur.BaseGameObject

gameObjectName, id

Method Summary

Modifier and Type	Method and Description
boolean	attack(Tile tile) Attacks an adjacent Tile.
boolean	changeJob(java.lang.String job) Changes this Unit's Job.
boolean	construct(Tile tile, java.lang.String type) Constructs a Structure on an adjacent Tile.
boolean	convert(Tile tile) Converts an adjacent Unit to your side.
boolean	deconstruct(Tile tile) Removes materials from an adjacent Tile's Structure.
boolean	drop(Tile tile, java.lang.String resource) Defaults the value for the optional arg 'amount' to '0'
boolean	drop(Tile tile, java.lang.String resource, int amount) Drops some of the given resource on or adjacent to the Unit's Tile.
boolean	harvest(Tile tile) Harvests the food on an adjacent Tile.
boolean	move(Tile tile) Moves this Unit from its current Tile to an adjacent Tile.
boolean	pickup(Tile tile, java.lang.String resource) Defaults the value for the optional arg 'amount' to '0'
boolean	pickup(Tile tile, java.lang.String resource, int amount) Picks up some materials or food on or adjacent to the Unit's Tile.
boolean	rest() Regenerates energy.

Methods inherited from class games.catastrophe.GameObject

log

Methods inherited from class joueur.BaseGameObject

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

acted

public boolean acted

Whether this Unit has performed its action this turn.

energy

public double energy

The amount of energy this Unit has (from 0.0 to 100.0).

food

public int food

The amount of food this Unit is holding.

job

public Job job

The Job this Unit was recruited to do.

materials

public int materials

The amount of materials this Unit is holding.

movementTarget

public Tile movementTarget

The tile this Unit is moving to. This only applies to neutral fresh humans spawned on the road. Otherwise, the tile this Unit is on.

moves

public int moves

How many moves this Unit has left this turn.

owner

public Player owner

The Player that owns and can control this Unit, or null if the Unit is neutral.

squad

public java.util.List<Unit> squad

The Units in the same squad as this Unit. Units in the same squad attack and defend together.

starving

public boolean starving

Whether this Unit is starving. Starving Units regenerate energy at half the rate they normally would while resting.

tile

public Tile tile

The Tile this Unit is on.

turnsToDie

public int turnsToDie

The number of turns before this Unit dies. This only applies to neutral fresh humans created from combat. Otherwise, 0.

Method Detail

attack

public boolean attack(Tile tile)

Attacks an adjacent Tile. Costs an action for each Unit in this Unit's squad. Units in the squad without an action don't participate in combat. Units in combat cannot move afterwards. Attacking structures will not give materials.

Parameters:

tile - The Tile to attack.

Returns:

True if successfully attacked, false otherwise.

changeJob

public boolean changeJob(java.lang.String job)

Changes this Unit's Job. Must be at max energy (100) to change Jobs.

Parameters:

job - The name of the Job to change to.

Returns:

True if successfully changed Jobs, false otherwise.

construct

public boolean construct(Tile tile,
                         java.lang.String type)

Constructs a Structure on an adjacent Tile.

Parameters:

tile - The Tile to construct the Structure on. It must have enough materials on it for a Structure to be constructed.

type - The type of Structure to construct on that Tile.

Returns:

True if successfully constructed a structure, false otherwise.

convert

public boolean convert(Tile tile)

Converts an adjacent Unit to your side.

Parameters:

tile - The Tile with the Unit to convert.

Returns:

True if successfully converted, false otherwise.

deconstruct

public boolean deconstruct(Tile tile)

Removes materials from an adjacent Tile's Structure. You cannot deconstruct friendly structures (see `Unit.attack`).

Parameters:

tile - The Tile to deconstruct. It must have a Structure on it.

Returns:

True if successfully deconstructed, false otherwise.

drop

public boolean drop(Tile tile,
                    java.lang.String resource)

Defaults the value for the optional arg 'amount' to '0'

See Also:

drop(Tile, String, int)

drop

public boolean drop(Tile tile,
                    java.lang.String resource,
                    int amount)

Drops some of the given resource on or adjacent to the Unit's Tile. Does not count as an action.

Parameters:

tile - The Tile to drop materials/food on.

resource - The type of resource to drop ('materials' or 'food').

amount - The amount of the resource to drop. Amounts <= 0 will drop as much as possible.

Returns:

True if successfully dropped the resource, false otherwise.

harvest

public boolean harvest(Tile tile)

Harvests the food on an adjacent Tile.

Parameters:

tile - The Tile you want to harvest.

Returns:

True if successfully harvested, false otherwise.

move

public boolean move(Tile tile)

Moves this Unit from its current Tile to an adjacent Tile.

Parameters:

tile - The Tile this Unit should move to.

Returns:

True if it moved, false otherwise.

pickup

public boolean pickup(Tile tile,
                      java.lang.String resource)

Defaults the value for the optional arg 'amount' to '0'

See Also:

pickup(Tile, String, int)

pickup

public boolean pickup(Tile tile,
                      java.lang.String resource,
                      int amount)

Picks up some materials or food on or adjacent to the Unit's Tile. Does not count as an action.

Parameters:

tile - The Tile to pickup materials/food from.

resource - The type of resource to pickup ('materials' or 'food').

amount - The amount of the resource to pickup. Amounts <= 0 will pickup as much as possible.

Returns:

True if successfully picked up a resource, false otherwise.

rest

public boolean rest()

Regenerates energy. Must be in range of a friendly shelter to rest. Costs an action. Units cannot move after resting.

Returns:

True if successfully rested, false otherwise.