Package com.csse3200.game.components.resources

Class ProductionComponent

java.lang.Object

com.csse3200.game.components.Component

com.csse3200.game.components.resources.ProductionComponent

public class ProductionComponent
extends Component

Field Summary

Fields inherited from class com.csse3200.game.components.Component

enabled, entity, logger

Constructor Summary

Constructors

Constructor	Description
ProductionComponent(Resource produces, long tickRate, int tickSize)	ProductionComponent allows an entity to produce resources on some real time interval and send them to the gameState and event handler.

Method Summary

Modifier and Type	Method	Description
void	create()	Called when the entity is created and registered.
Resource	getProduces()
long	getProductionModifier()	getProductionModifier returns a value between 0 and 1 for how efficient the extractor is.
void	setTimer(GameTime timer)
void	update()	Called once per frame of the game, and should be used for most component logic.

Methods inherited from class com.csse3200.game.components.Component

dispose, earlyUpdate, getEntity, setEnabled, setEntity, toString, triggerEarlyUpdate, triggerUpdate

Methods inherited from class java.lang.Object

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

Constructor Details

ProductionComponent

public ProductionComponent(Resource produces,
 long tickRate,
 int tickSize)

ProductionComponent allows an entity to produce resources on some real time interval and send them to the gameState and event handler.

Parameters:

produces - the resource type this should produce

tickRate - the amount of miliseconds between ticks (not guaranteed but catchup is performed if a tick is missed)

tickSize - the amount of the resource to produce on each tick

Method Details

getProduces

public Resource getProduces()

create

public void create()

Description copied from class: Component

Called when the entity is created and registered. Initial logic such as calls to GetComponent should be made here, not in the constructor which is called before an entity is finished.

Overrides:

create in class Component

getProductionModifier

public long getProductionModifier()

getProductionModifier returns a value between 0 and 1 for how efficient the extractor is. For example a fully functioning extractor would have an efficiency of 1.0, and a broken one 0.0.

Returns:

long between 0 and 1.

update

public void update()

Description copied from class: Component

Called once per frame of the game, and should be used for most component logic. Not called if component is disabled.

Overrides:

update in class Component

setTimer

public void setTimer(GameTime timer)