com.b3dgs.lionengine.game
Class Alterable

java.lang.Object
  extended by com.b3dgs.lionengine.game.Alterable

public class Alterable
extends java.lang.Object

Represents a value which can change between 0 and a maximum. It is mainly used in complement with Attributes, to represent life, mana...

See Also:
AbstractAttributes

Constructor Summary
Alterable(int max)
          Create a new alterable.
 
Method Summary
 void decrease(int dec)
          Decrease current value.
 void fill()
          Fill until max value (set current value to max).
 int getCurrent()
          Get current value.
 int getMax()
          Get maximum reachable value.
 int getPercent()
          Get percent value (depending of current/max).
 void increase(int inc)
          Increase current value.
 void set(int value)
          Set current value.
 void setMax(int max)
          Set maximum reachable value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Alterable

public Alterable(int max)
Create a new alterable.

Parameters:
max - maximum reachable value.
Method Detail

increase

public void increase(int inc)
Increase current value.

Parameters:
inc - increase step.

decrease

public void decrease(int dec)
Decrease current value.

Parameters:
dec - decrease step.

set

public void set(int value)
Set current value.

Parameters:
value - current value.

setMax

public void setMax(int max)
Set maximum reachable value.

Parameters:
max - maximum reachable value.

fill

public void fill()
Fill until max value (set current value to max).


getMax

public int getMax()
Get maximum reachable value.

Returns:
maximum reachable value.

getCurrent

public int getCurrent()
Get current value.

Returns:
current value.

getPercent

public int getPercent()
Get percent value (depending of current/max).

Returns:
percent value.