Class ResourceDeposit

java.lang.Object

idlab.colonyops.model.entities.AbstractEntity

idlab.colonyops.model.entities.ResourceDeposit

All Implemented Interfaces:

Entity

public class ResourceDeposit
extends AbstractEntity

A location containing extractable resources of a single ResourceType, mined via ExtractResourceAction. Once its quantity is exhausted, the deposit is removed from the map.

Normal deposits are scattered across the map at planet generation; large deposits (isLargeDeposit()) are discovered mid-mission via orbital scans and contain substantially more resources.

Field Summary

Fields inherited from class AbstractEntity

colonyId, id, location

Constructor Summary

Constructors

Constructor	Description
ResourceDeposit()
ResourceDeposit(String id, Location location, ResourceType resourceType, int quantity, boolean largeDeposit, int maxQuantity)

Method Summary

Modifier and Type	Method	Description
int	getMaxQuantity()
int	getQuantity()
ResourceType	getResourceType()
boolean	isLargeDeposit()
void	setLargeDeposit(boolean largeDeposit)
void	setMaxQuantity(int maxQuantity)
void	setQuantity(int quantity)
void	setResourceType(ResourceType resourceType)

Methods inherited from class AbstractEntity

equals, getColonyId, getId, getLocation, hashCode, setColonyId, setId, setLocation

Methods inherited from class Object

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

Constructor Details

ResourceDeposit

public ResourceDeposit()

ResourceDeposit

public ResourceDeposit(String id,
 Location location,
 ResourceType resourceType,
 int quantity,
 boolean largeDeposit,
 int maxQuantity)

Method Details

getResourceType

public ResourceType getResourceType()

setResourceType

public void setResourceType(ResourceType resourceType)

getQuantity

public int getQuantity()

Returns:

the amount of resource remaining to be extracted

setQuantity

public void setQuantity(int quantity)

isLargeDeposit

public boolean isLargeDeposit()

Returns:

true if this is a large deposit discovered via an orbital scan, rather than a normal deposit placed at planet generation

setLargeDeposit

public void setLargeDeposit(boolean largeDeposit)

getMaxQuantity

public int getMaxQuantity()

Returns:

the deposit's original quantity when it was created

setMaxQuantity

public void setMaxQuantity(int maxQuantity)