games.coreminer

Class Miner

java.lang.Object

joueur.BaseGameObject

games.coreminer.GameObject

games.coreminer.Miner

public class Miner
extends GameObject

A Miner in the game.

Field Summary

Fields

Modifier and Type	Field and Description
int	bombs The number of bombs being carried by this Miner.
int	buildingMaterials The number of building materials carried by this Miner.
Upgrade	currentUpgrade The Upgrade this Miner is on.
int	dirt The amount of dirt carried by this Miner.
int	health The remaining health of this Miner.
int	miningPower The remaining mining power this Miner has this turn.
int	moves The number of moves this Miner has left this turn.
int	ore The amount of ore carried by this Miner.
Player	owner The Player that owns and can control this Miner.
Tile	tile The Tile this Miner is on.
int	upgradeLevel The upgrade level of this Miner.

Fields inherited from class games.coreminer.GameObject

logs

Fields inherited from class joueur.BaseGameObject

gameObjectName, id

Method Summary

Modifier and Type	Method and Description
boolean	build(Tile tile, java.lang.String type) Builds a support, shield, or ladder on Miner's Tile, or an adjacent Tile.
boolean	buy(java.lang.String resource, int amount) Purchase a resource from the Player's base or hopper.
boolean	dump(Tile tile, java.lang.String material, int amount) Dumps materials from cargo to an adjacent Tile.
boolean	mine(Tile tile, int amount) Mines the Tile the Miner is on or an adjacent Tile.
boolean	move(Tile tile) Moves this Miner from its current Tile to an adjacent Tile.
boolean	transfer(Miner miner, java.lang.String resource, int amount) Transfers a resource from the one Miner to another.
boolean	upgrade() Upgrade this Miner by installing an upgrade module.

Methods inherited from class games.coreminer.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

bombs

public int bombs

The number of bombs being carried by this Miner.

buildingMaterials

public int buildingMaterials

The number of building materials carried by this Miner.

currentUpgrade

public Upgrade currentUpgrade

The Upgrade this Miner is on.

dirt

public int dirt

The amount of dirt carried by this Miner.

health

public int health

The remaining health of this Miner.

miningPower

public int miningPower

The remaining mining power this Miner has this turn.

moves

public int moves

The number of moves this Miner has left this turn.

ore

public int ore

The amount of ore carried by this Miner.

owner

public Player owner

The Player that owns and can control this Miner.

tile

public Tile tile

The Tile this Miner is on.

upgradeLevel

public int upgradeLevel

The upgrade level of this Miner. Starts at 0.

Method Detail

build

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

Builds a support, shield, or ladder on Miner's Tile, or an adjacent Tile.

Parameters:

tile - The Tile to build on.

type - The structure to build (support, ladder, or shield).

Returns:

True if successfully built, False otherwise.

buy

public boolean buy(java.lang.String resource,
                   int amount)

Purchase a resource from the Player's base or hopper.

Parameters:

resource - The type of resource to buy.

amount - The amount of resource to buy. Amounts <= 0 will buy all of that material Player can.

Returns:

True if successfully purchased, false otherwise.

dump

public boolean dump(Tile tile,
                    java.lang.String material,
                    int amount)

Dumps materials from cargo to an adjacent Tile. If the Tile is a base or a hopper Tile, materials are sold instead of placed.

Parameters:

tile - The Tile the materials will be dumped on.

material - The material the Miner will drop. 'dirt', 'ore', or 'bomb'.

amount - The number of materials to drop. Amounts <= 0 will drop all of the material.

Returns:

True if successfully dumped materials, false otherwise.

mine

public boolean mine(Tile tile,
                    int amount)

Mines the Tile the Miner is on or an adjacent Tile.

Parameters:

tile - The Tile the materials will be mined from.

amount - The amount of material to mine up. Amounts <= 0 will mine all the materials that the Miner can.

Returns:

True if successfully mined, false otherwise.

move

public boolean move(Tile tile)

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

Parameters:

tile - The Tile this Miner should move to.

Returns:

True if it moved, false otherwise.

transfer

public boolean transfer(Miner miner,
                        java.lang.String resource,
                        int amount)

Transfers a resource from the one Miner to another.

Parameters:

miner - The Miner to transfer materials to.

resource - The type of resource to transfer.

amount - The amount of resource to transfer. Amounts <= 0 will transfer all the of the material.

Returns:

True if successfully transferred, false otherwise.

upgrade

public boolean upgrade()

Upgrade this Miner by installing an upgrade module.

Returns:

True if successfully upgraded, False otherwise.