com.almasb.fxgl.entity.component

Class RechargeableComponent

java.lang.Object

com.almasb.fxgl.entity.Module

com.almasb.fxgl.entity.Component

com.almasb.fxgl.entity.component.DoubleComponent

com.almasb.fxgl.entity.component.RechargeableComponent

All Implemented Interfaces:

SerializableComponent

public abstract class RechargeableComponent
extends DoubleComponent

Any rechargeable component, such as HP, SP, ammo, etc. The internal value is a double in the range [0..maxValue].

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Properties inherited from class com.almasb.fxgl.entity.component.DoubleComponent

valueProperty

Constructor Summary

Constructors

Constructor and Description
RechargeableComponent(double maxValue)

Method Summary

Modifier and Type	Method and Description
void	damage(double value) Damage component by given value.
void	damagePercentageCurrent(double value) Damage component by given percentage.
void	damagePercentageMax(double value) Damage component by given percentage.
double	getMaxValue()
boolean	isZero() Check if value is 0.
void	restore(double value) Restore component by given value.
void	restorePercentageCurrent(double value) Restore component by given percentage.
void	restorePercentageMax(double value) Restore by given percentage.
void	setMaxValue(double maxValue) Set max value.

Methods inherited from class com.almasb.fxgl.entity.component.DoubleComponent

getValue, read, setValue, toString, valueProperty, write

Methods inherited from class com.almasb.fxgl.entity.Module

getEntity, onAdded, onRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

RechargeableComponent

public RechargeableComponent(double maxValue)

Method Detail

getMaxValue

public double getMaxValue()

Returns:

max value

setMaxValue

public void setMaxValue(double maxValue)

Set max value.

Parameters:

maxValue - max value

damage

public void damage(double value)

Damage component by given value.

Parameters:

value - the damage amount

damagePercentageCurrent

public void damagePercentageCurrent(double value)

Damage component by given percentage. The percentage is calculated from current value.

Parameters:

value - percentage of current value

damagePercentageMax

public void damagePercentageMax(double value)

Damage component by given percentage. The percentage is calculated from max value.

Parameters:

value - percentage of max value

restore

public void restore(double value)

Restore component by given value.

Parameters:

value - the amount to restore

restorePercentageCurrent

public void restorePercentageCurrent(double value)

Restore component by given percentage. The percentage is calculated from current value.

Parameters:

value - percentage of current value

restorePercentageMax

public void restorePercentageMax(double value)

Restore by given percentage. The percentage is calculated from max value.

Parameters:

value - percentage of max value

isZero

public boolean isZero()

Check if value is 0. Note that because internal value is a double, value of 0.xx will not return true.

Returns:

true iff value is 0