java.lang.Object
- com.starpoints.state.ThingState
- - com.starpoints.state.FigureState

All Implemented Interfaces:

java.io.Serializable
```
public class FigureState
extends ThingState
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class com.starpoints.state.ThingState
  energy, maxEnergy, name

Constructor Summary

Constructors
Constructor Description

FigureState(java.lang.String className, int ID, java.lang.String imageName)
Creates a FigureState.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addAdditionalEquipment(java.lang.String equipment)`	Adds an additional equipment.
`void`	`addPermanentItem(PermanentItemState permanentItem)`	Adds a permanent item.
`void`	`addSkinOverlayImage(java.lang.String skinOverlayImage)`	Adds a skin overlay image.
`java.util.List<java.lang.String>`	`getAdditionalEquipment()`	Gets the list of additional equipment.
`DieReason`	`getDieReason()`
`FigureMove`	`getFigureMove()`	Gets the figure move.
`FigureRocketHit`	`getFigureRocketHit()`	Gets the FigureRocketHit.
`FigureShielding`	`getFigureShielding()`	Gets the FigureShielding.
`int`	`getHeatLevel()`
`int`	`getHoverHeight()`
`int`	`getHoverRounds()`
`int`	`getInitialEnergy()`
`int`	`getInitialExplosionShielding()`
`int`	`getInitialHeatShielding()`
`int`	`getInitialRamShielding()`
`int`	`getInitialRocketShielding()`
`int`	`getInvisibilityDuration()`
`int`	`getInvulnerableDuration()`
`ItemState`	`getItem()`	Gets the figures item.
`int`	`getLevelScore()`
`int`	`getLifes()`
`int`	`getMoney()`
`int`	`getNumber()`
`java.util.List<PermanentItemState>`	`getPermanentItems()`	Gets a list of permanent items.
`int`	`getPointColor()`
`long`	`getPoints()`
`int`	`getRamPower()`
`int`	`getShielding()`
`java.util.List<java.lang.String>`	`getSkinOverlayImages()`	The list of skin overlay images.
`int`	`getSlots()`
`int`	`getStunDuration()`	Gets the stun duration.
`Direction`	`getViewDirection()`	Gets the view direction.
`int`	`getWinCount()`
`boolean`	`hasAdditionalEquipment(java.lang.String equipment)`	Checks, if the figure has a certain additional equipment.
`boolean`	`isDrawingNumber()`	Flag, if number should be drawn on figure.
`boolean`	`isDummy()`	Checks if the figure is a dummy.
`boolean`	`isHovering()`	Returns true, if this figure is currently hovering.
`boolean`	`isPaintingItemsOnFigure()`
`boolean`	`isPlayer()`	Checks if the figure is a human player.
`boolean`	`isSinking()`	Returns true, if this figure is currently sinking.
`boolean`	`isStunned()`	Returns true, if this figure is currently stunned.
`boolean`	`isVisible()`
`void`	`setDieReason(DieReason dieReason)`
`void`	`setDummy(boolean isDummy)`	Sets if the figure is a dummy.
`void`	`setFigureMove(FigureMove figureMove)`	Sets the FigureMove.
`void`	`setFigureRocketHit(FigureRocketHit figureRocketHit)`	Sets the FigureRocketHit.
`void`	`setFigureShielding(FigureShielding figureShielding)`	Sets the FigureShielding.
`void`	`setHeatLevel(int heatLevel)`
`void`	`setHoverHeight(int hoverHeight)`
`void`	`setHoverRounds(int hoverRounds)`
`void`	`setInitialEnergy(int initialEnergy)`
`void`	`setInitialExplosionShielding(int initialExplosionShielding)`
`void`	`setInitialHeatShielding(int initialHeatShielding)`
`void`	`setInitialRamShielding(int initialRamShielding)`
`void`	`setInitialRocketShielding(int initialRocketShielding)`
`void`	`setInvisibilityDuration(int invisibilityDuration)`
`void`	`setInvulnerableDuration(int invulnerableDuration)`
`void`	`setItem(ItemState item)`	Seets the item.
`void`	`setLevelScore(int levelScore)`
`void`	`setLifes(int lifes)`
`void`	`setMoney(int money)`
`void`	`setNumber(int number)`	Sets the figures number.
`void`	`setPaintItemsOnFigure(boolean paintItemsOnFigure)`
`void`	`setPlayer(boolean isPlayer)`	Sets if the figure is a human player.
`void`	`setPointColor(int pointColor)`
`void`	`setPoints(long l)`
`void`	`setRamPower(int ramPower)`
`void`	`setShielding(int shielding)`
`void`	`setSlots(int slots)`
`void`	`setStunDuration(int stunDuration)`	Sets the stun duration.
`void`	`setViewDirection(Direction viewDir)`	Sets the view direction.
`void`	`setVisible(boolean isVisible)`
`void`	`setWinCount(int winCount)`
`java.lang.String`	`toString()`	Gets a string representation.

Methods inherited from class com.starpoints.state.ThingState
addProperty, equals, getBooleanProperty, getClassName, getColor, getEnergy, getEnergyMaxCount, getExplosionCounter, getID, getImageName, getIntProperty, getMaxEnergy, getName, getOuterColor, getProperties, getProperty, getStatus, getText, getTextColor, getTextCounter, getX, getY, hashCode, isDestroyed, isExploding, isInvulnerable, isOK, setColor, setEnergy, setEnergyMaxCount, setExplosionCounter, setID, setImageName, setMaxEnergy, setName, setOK, setOuterColor, setStatus, setText, setTextColor, setTextCounter, setX, setY

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FigureState
```
public FigureState(java.lang.String className,
                   int ID,
                   java.lang.String imageName)
```
    Creates a FigureState.
    
    Parameters:
    
    className -
    
    ID -
- Method Detail
  - getItem
```
public ItemState getItem()
```
    Gets the figures item.
    
    Returns:
    
    The item.
  - setItem
```
public void setItem(ItemState item)
```
    Seets the item.
    
    Parameters:
    
    item - The item to set.
  - getAdditionalEquipment
```
public java.util.List<java.lang.String> getAdditionalEquipment()
```
    Gets the list of additional equipment.
    
    Returns:
    
    the additional equipments.
  - addAdditionalEquipment
```
public void addAdditionalEquipment(java.lang.String equipment)
```
    Adds an additional equipment.
    
    Parameters:
    
    equipment - the additional equipment to add
  - getPermanentItems
```
public java.util.List<PermanentItemState> getPermanentItems()
```
    Gets a list of permanent items.
    
    Returns:
    
    the permanentItems.
  - hasAdditionalEquipment
```
public boolean hasAdditionalEquipment(java.lang.String equipment)
```
    Checks, if the figure has a certain additional equipment.
    
    Returns:
    
    true, if the figure has the certain additional equipment.
  - addPermanentItem
```
public void addPermanentItem(PermanentItemState permanentItem)
```
    Adds a permanent item.
    
    Parameters:
    
    permanentItem - the permanentItems to add.
  - getHeatLevel
```
public int getHeatLevel()
```
    Returns:
    
    the heatLevel
  - setHeatLevel
```
public void setHeatLevel(int heatLevel)
```
    Parameters:
    
    heatLevel - the heatLevel to set
  - getHoverHeight
```
public int getHoverHeight()
```
    Returns:
    
    the hoverHeight
  - setHoverHeight
```
public void setHoverHeight(int hoverHeight)
```
    Parameters:
    
    hoverHeight - the hoverHeight to set
  - getHoverRounds
```
public int getHoverRounds()
```
    Returns:
    
    the hoverRounds
  - setHoverRounds
```
public void setHoverRounds(int hoverRounds)
```
    Parameters:
    
    hoverRounds - the hoverRounds to set
  - getMoney
```
public int getMoney()
```
    Returns:
    
    the money
  - setMoney
```
public void setMoney(int money)
```
    Parameters:
    
    money - the money to set
  - getLevelScore
```
public int getLevelScore()
```
    Returns:
    
    the levelScore
  - setLevelScore
```
public void setLevelScore(int levelScore)
```
    Parameters:
    
    levelScore - the levelScore to set
  - getPoints
```
public long getPoints()
```
    Returns:
    
    the points
  - setPoints
```
public void setPoints(long l)
```
    Parameters:
    
    l - the points to set
  - getLifes
```
public int getLifes()
```
    Returns:
    
    the lifes
  - setLifes
```
public void setLifes(int lifes)
```
    Parameters:
    
    lifes - the lifes to set
  - getInitialEnergy
```
public int getInitialEnergy()
```
    Returns:
    
    the initialEnergy
  - setInitialEnergy
```
public void setInitialEnergy(int initialEnergy)
```
    Parameters:
    
    initialEnergy - the initialEnergy to set
  - getSlots
```
public int getSlots()
```
    Returns:
    
    the slots
  - setSlots
```
public void setSlots(int slots)
```
    Parameters:
    
    slots - the slots to set
  - getWinCount
```
public int getWinCount()
```
    Returns:
    
    the winCount
  - setWinCount
```
public void setWinCount(int winCount)
```
    Parameters:
    
    winCount - the winCount to set
  - getDieReason
```
public DieReason getDieReason()
```
    Returns:
    
    the dieReason
  - setDieReason
```
public void setDieReason(DieReason dieReason)
```
    Parameters:
    
    dieReason - the dieReason to set
  - getPointColor
```
public int getPointColor()
```
    Returns:
    
    the pointColor
  - setPointColor
```
public void setPointColor(int pointColor)
```
    Parameters:
    
    pointColor - the pointColor to set
  - getShielding
```
public int getShielding()
```
    Returns:
    
    the shielding
  - setShielding
```
public void setShielding(int shielding)
```
    Parameters:
    
    shielding - the shielding to set
  - getInvulnerableDuration
```
public int getInvulnerableDuration()
```
    Returns:
    
    the invulnerabiliy duration
  - setInvulnerableDuration
```
public void setInvulnerableDuration(int invulnerableDuration)
```
    Parameters:
    
    invulnerableDuration - The invulnerability duration to set
  - getInvisibilityDuration
```
public int getInvisibilityDuration()
```
    Returns:
    
    the invisibilityRounds
  - setInvisibilityDuration
```
public void setInvisibilityDuration(int invisibilityDuration)
```
    Parameters:
    
    invisibilityDuration - The invisibility duration to set
  - isVisible
```
public boolean isVisible()
```
    Returns:
    
    the isVisible
  - setVisible
```
public void setVisible(boolean isVisible)
```
    Parameters:
    
    isVisible - the isVisible to set
  - getRamPower
```
public int getRamPower()
```
    Returns:
    
    the ramPower
  - setRamPower
```
public void setRamPower(int ramPower)
```
    Parameters:
    
    ramPower - the ramPower to set
  - isDummy
```
public boolean isDummy()
```
    Checks if the figure is a dummy.
    
    Returns:
  - setDummy
```
public void setDummy(boolean isDummy)
```
    Sets if the figure is a dummy.
    
    Parameters:
    
    isDummy -
  - isPlayer
```
public boolean isPlayer()
```
    Checks if the figure is a human player.
    
    Returns:
  - isPaintingItemsOnFigure
```
public boolean isPaintingItemsOnFigure()
```
    Returns:
    
    the paintItemsOnFigure
  - setPaintItemsOnFigure
```
public void setPaintItemsOnFigure(boolean paintItemsOnFigure)
```
    Parameters:
    
    paintItemsOnFigure - the paintItemsOnFigure to set
  - isHovering
```
public boolean isHovering()
```
    Returns true, if this figure is currently hovering.
    
    Returns:
    
    true, if figure hovers.
  - isSinking
```
public boolean isSinking()
```
    Returns true, if this figure is currently sinking.
    
    Returns:
    
    true, if figure sinks.
  - setPlayer
```
public void setPlayer(boolean isPlayer)
```
    Sets if the figure is a human player.
    
    Parameters:
    
    isPlayer -
  - getFigureMove
```
public FigureMove getFigureMove()
```
    Gets the figure move.
    
    Returns:
    
    The figureMove.
  - setFigureMove
```
public void setFigureMove(FigureMove figureMove)
```
    Sets the FigureMove.
    
    Parameters:
    
    figureMove - The figureMove to set.
  - getFigureRocketHit
```
public FigureRocketHit getFigureRocketHit()
```
    Gets the FigureRocketHit.
    
    Returns:
    
    the FigureRocketHit.
  - setFigureRocketHit
```
public void setFigureRocketHit(FigureRocketHit figureRocketHit)
```
    Sets the FigureRocketHit.
    
    Parameters:
    
    figureRocketHit - The figureRocketHit to set.
  - getFigureShielding
```
public FigureShielding getFigureShielding()
```
    Gets the FigureShielding.
    
    Returns:
    
    The figureShielding.
  - setFigureShielding
```
public void setFigureShielding(FigureShielding figureShielding)
```
    Sets the FigureShielding.
    
    Parameters:
    
    figureShielding - The figureShielding to set.
  - getInitialExplosionShielding
```
public int getInitialExplosionShielding()
```
  - setInitialExplosionShielding
```
public void setInitialExplosionShielding(int initialExplosionShielding)
```
  - getInitialRamShielding
```
public int getInitialRamShielding()
```
  - setInitialRamShielding
```
public void setInitialRamShielding(int initialRamShielding)
```
  - getInitialRocketShielding
```
public int getInitialRocketShielding()
```
  - setInitialRocketShielding
```
public void setInitialRocketShielding(int initialRocketShielding)
```
  - getInitialHeatShielding
```
public int getInitialHeatShielding()
```
  - setInitialHeatShielding
```
public void setInitialHeatShielding(int initialHeatShielding)
```
  - toString
```
public java.lang.String toString()
```
    Gets a string representation.
    
    Overrides:
    
    toString in class ThingState
    
    Returns:
    
    "FigureState: NAME [EN/MaxEN]"
  - getNumber
```
public int getNumber()
```
    Returns:
    
    the number
  - getSkinOverlayImages
```
public java.util.List<java.lang.String> getSkinOverlayImages()
```
    The list of skin overlay images.
    
    Returns:
    
    The skinOverlayImages.
  - addSkinOverlayImage
```
public void addSkinOverlayImage(java.lang.String skinOverlayImage)
```
    Adds a skin overlay image.
    
    Parameters:
    
    skinOverlayImage - the skinOverlayImage to add
  - setNumber
```
public void setNumber(int number)
```
    Sets the figures number.
    
    Parameters:
    
    number - The number to set.
  - isDrawingNumber
```
public boolean isDrawingNumber()
```
    Flag, if number should be drawn on figure.
    
    Returns:
    
    true, if number is != -1.
  - isStunned
```
public boolean isStunned()
```
    Returns true, if this figure is currently stunned.
    
    Returns:
    
    true, if the figure is stunned, false otherwise.
  - getStunDuration
```
public int getStunDuration()
```
    Gets the stun duration.
    
    Returns:
    
    The stunDuration.
  - setStunDuration
```
public void setStunDuration(int stunDuration)
```
    Sets the stun duration.
    
    Parameters:
    
    stunDuration - The stunDuration to set.
  - getViewDirection
```
public Direction getViewDirection()
```
    Gets the view direction.
    
    Returns:
  - setViewDirection
```
public void setViewDirection(Direction viewDir)
```
    Sets the view direction.
    
    Parameters:
    
    viewDir -

Class FigureState

Field Summary

Fields inherited from class com.starpoints.state.ThingState

Constructor Summary

Method Summary

Methods inherited from class com.starpoints.state.ThingState

Methods inherited from class java.lang.Object

Constructor Detail

FigureState

Method Detail

getItem

setItem

getAdditionalEquipment

addAdditionalEquipment

getPermanentItems

hasAdditionalEquipment

addPermanentItem

getHeatLevel

setHeatLevel

getHoverHeight

setHoverHeight

getHoverRounds

setHoverRounds

getMoney

setMoney

getLevelScore

setLevelScore

getPoints

setPoints

getLifes

setLifes

getInitialEnergy

setInitialEnergy

getSlots

setSlots

getWinCount

setWinCount

getDieReason

setDieReason

getPointColor

setPointColor

getShielding

setShielding

getInvulnerableDuration

setInvulnerableDuration

getInvisibilityDuration

setInvisibilityDuration

isVisible

setVisible

getRamPower

setRamPower

isDummy

setDummy

isPlayer

isPaintingItemsOnFigure

setPaintItemsOnFigure

isHovering

isSinking

setPlayer

getFigureMove

setFigureMove

getFigureRocketHit

setFigureRocketHit

getFigureShielding

setFigureShielding

getInitialExplosionShielding

setInitialExplosionShielding

getInitialRamShielding

setInitialRamShielding

getInitialRocketShielding

setInitialRocketShielding

getInitialHeatShielding

setInitialHeatShielding

toString

getNumber

getSkinOverlayImages

addSkinOverlayImage

setNumber

isDrawingNumber

isStunned