com.b3dgs.lionengine.game.purviews
Class Configurable

java.lang.Object
  extended by com.b3dgs.lionengine.game.purviews.Configurable
Direct Known Subclasses:
Entity

public class Configurable
extends java.lang.Object

Purview representing an object which can be externally configured. When data are loaded, the object can used internally theses data.


Constructor Summary
Configurable()
           
Configurable(Configurable configurable)
           
 
Method Summary
protected  void checkInstruction(java.lang.String type, java.lang.String line)
          Can be overrided to complete instruction storage from decoding.
 Animation getAnim(java.lang.String name)
          Get animation data from its name.
 CollisionArea getCollArea(java.lang.String name)
          Get collision area structure from data name.
 java.lang.Object getData(java.lang.String name)
          Get any kind of data from its name.
 boolean getDataBool(java.lang.String name)
          Get boolean value from data name.
 int getDataInt(java.lang.String name)
          Get floating value from data name.
 java.lang.String getDataString(java.lang.String name)
          Get string value from data name.
 Range getRange(java.lang.String name)
          Get range data from its name.
 void loadData(java.lang.String filename)
          Load player data from an external file, structured using elements such as =STR=, =ANM=...
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Configurable

public Configurable()

Configurable

public Configurable(Configurable configurable)
Method Detail

loadData

public void loadData(java.lang.String filename)
Load player data from an external file, structured using elements such as =STR=, =ANM=...

Parameters:
filename - file localisation.

checkInstruction

protected void checkInstruction(java.lang.String type,
                                java.lang.String line)
Can be overrided to complete instruction storage from decoding.

Parameters:
type - current instruction type.
line - current decoding line.

getData

public java.lang.Object getData(java.lang.String name)
Get any kind of data from its name. Cast is needed to get the correct value.

Parameters:
name - instruction name.
Returns:
instruction value.

getDataString

public java.lang.String getDataString(java.lang.String name)
Get string value from data name.

Parameters:
name - instruction name.
Returns:
instruction value.

getDataBool

public boolean getDataBool(java.lang.String name)
Get boolean value from data name.

Parameters:
name - instruction name.
Returns:
instruction value.

getDataInt

public int getDataInt(java.lang.String name)
Get floating value from data name.

Parameters:
name - instruction name.
Returns:
instruction value.

getCollArea

public CollisionArea getCollArea(java.lang.String name)
Get collision area structure from data name.

Parameters:
name - instruction name.
Returns:
instruction value.

getAnim

public Animation getAnim(java.lang.String name)
Get animation data from its name.

Parameters:
name - animation name.
Returns:
animation data.

getRange

public Range getRange(java.lang.String name)
Get range data from its name.

Parameters:
name - range name.
Returns:
range data.