CharacterData

java.lang.Object
- struct.CharacterData

```
public class CharacterData
extends java.lang.Object
```
The class dealing with data on the character such as the character's HP, energy, coordinates.

Constructor Summary

Constructors
Constructor and Description
`CharacterData(fighting.Character character)` The class constructor that acquires information on the character from an instance of the Character class passed as the argument and newly creates an instance of the CharacterData class.
`CharacterData(CharacterData characterData)` The copy constructor that creates a copy of an instance of the CharacterData class passed as the argument.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Action`	`getAction()` Returns the character's action.
`AttackData`	`getAttack()` Returns the attack data that the character is using.
`int`	`getBottom()` Returns the character's hit box's most-bottom y-coordinate.
`int`	`getCenterX()` Returns the character's hit box's center x-coordinate.
`int`	`getCenterY()` Returns the character's hit box's center y-coordinate.
`int`	`getEnergy()` Returns the character's energy.
`int`	`getGraphicAdjustX()` Returns the amount of movement in the horizontal direction used to adjust the x coordinate when determining the direction of the character.
`int`	`getGraphicSizeX()` Returns the character's graphic width.
`int`	`getGraphicSizeY()` Returns the character's graphic height.
`int`	`getHitCount()` Returns the continuous hit count of attacks used by this character.
`int`	`getHp()` Returns the character's HP.
`java.util.Deque<Key>`	`getInputCommand()` Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
`int`	`getLastHitFrame()` Returns the frame number of the last frame that an attack used by this character hit the opponent.
`int`	`getLeft()` Returns the character's hit box's most-left x-coordinate.
`java.util.Deque<Key>`	`getProcessedCommand()` Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
`int`	`getRemainingFrame()` Returns the number of frames that the character needs to resume to its normal status.
`int`	`getRight()` Returns the character's hit box's most-right x-coordinate.
`int`	`getSpeedX()` Returns the character's horizontal speed.
`int`	`getSpeedY()` Returns the character's vertical speed.
`State`	`getState()` Returns the character's state: STAND / CROUCH/ AIR / DOWN.
`int`	`getTop()` Returns the character's hit box's most-top y-coordinate.
`int`	`getX()` Deprecated. Use `getLeft()` or `getRight()` or `getCenterX()` instead
`int`	`getY()` Deprecated. Use `getTop()` or `getBottom()` or `getCenterY()` instead
`boolean`	`isControl()` Returns the flag whether this character can run a new motion with the motion's command.
`boolean`	`isFront()` Returns the character's facing direction.
`boolean`	`isHitConfirm()` Returns the flag whether the motion hits the opponent or not.
`boolean`	`isPlayerNumber()` Returns the character's side flag.
`void`	`setAction(Action action)` Sets the character's action.
`void`	`setAttack(AttackData attack)` Sets the character's attack.
`void`	`setBottom(int bottom)` Sets the character's hit box's most-bottom y-coordinate
`void`	`setControl(boolean control)` Sets the flag whether this character can run a new motion with the motion's command.
`void`	`setEnergy(int energy)` Sets the character's energy.
`void`	`setFront(boolean front)` Sets the character's facing direction.
`void`	`setHitConfirm(boolean hitConfirm)` Sets a boolean value whether the motion hits the opponent or not.
`void`	`setHitCount(int hitCount)` Sets the continuous hit count of attacks used by this character.
`void`	`setHp(int hp)` Sets the character's HP.
`void`	`setInputCommand(java.util.Deque<Key> inputCommand)` Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
`void`	`setLastHitFrame(int lastHitFrame)` Sets the frame number of the last frame that an attack used by this character hit the opponent.
`void`	`setLeft(int left)` Sets the character's hit box's most-left x-coordinate
`void`	`setProcessedCommand(java.util.Deque<Key> inputCommand)` Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
`void`	`setRemainingFrame(int remainingFrame)` Sets the number of frames that the character needs to resume to its normal status.
`void`	`setRight(int right)` Sets the character's hit box's most-right x-coordinate.
`void`	`setSpeedX(int speedX)` Sets the character's horizontal speed.
`void`	`setSpeedY(int speedY)` Sets the character's vertical speed.
`void`	`setState(State state)` Sets the character's state.
`void`	`setTop(int top)` Sets the character's hit box's most-top y-coordinate
`void`	`setX(int x)` Sets the character's horizontal position.
`void`	`setY(int y)` Sets the character's vertical position.

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

- Constructor Detail
  - CharacterData
```
public CharacterData(fighting.Character character)
```
    The class constructor that acquires information on the character from an instance of the Character class passed as the argument and newly creates an instance of the CharacterData class.
    
    Parameters:
    
    character - an instance of Character class
  - CharacterData
```
public CharacterData(CharacterData characterData)
```
    The copy constructor that creates a copy of an instance of the CharacterData class passed as the argument.
    
    Parameters:
    
    characterData - an instance of CharacterData class
- Method Detail
  - isPlayerNumber
```
public boolean isPlayerNumber()
```
    Returns the character's side flag.
    
    Returns:
    
    true if the character is P1, or false if P2
  - isFront
```
public boolean isFront()
```
    Returns the character's facing direction.
    
    Returns:
    
    true if the character is facing right, false otherwise
  - isControl
```
public boolean isControl()
```
    Returns the flag whether this character can run a new motion with the motion's command.
    
    Returns:
    
    true if the character can run, false otherwise
  - getHp
```
public int getHp()
```
    Returns the character's HP.
    
    Returns:
    
    the character's HP
  - getEnergy
```
public int getEnergy()
```
    Returns the character's energy.
    
    Returns:
    
    the character's energy
  - getX
```
public int getX()
```
    Deprecated. Use getLeft() or getRight() or getCenterX() instead
    
    Returns the character graphic's most top-left x-coordinate.
    
    Returns:
    
    the character graphic's most top-left x-coordinate
  - getY
```
public int getY()
```
    Deprecated. Use getTop() or getBottom() or getCenterY() instead
    
    Returns the character graphic's most top-left y-coordinate.
    
    Returns:
    
    the character graphic's most top-left y-coordinate
  - getLeft
```
public int getLeft()
```
    Returns the character's hit box's most-left x-coordinate.
    
    Returns:
    
    the character's hit box's most-left x-coordinate
  - getRight
```
public int getRight()
```
    Returns the character's hit box's most-right x-coordinate.
    
    Returns:
    
    the character's hit box's most-right x-coordinate
  - getTop
```
public int getTop()
```
    Returns the character's hit box's most-top y-coordinate.
    
    Returns:
    
    the character's hit box's most-top y-coordinate
  - getBottom
```
public int getBottom()
```
    Returns the character's hit box's most-bottom y-coordinate.
    
    Returns:
    
    the character's hit box's most-bottom y-coordinate
  - getCenterX
```
public int getCenterX()
```
    Returns the character's hit box's center x-coordinate.
    
    Returns:
    
    the character's hit box's center x-coordinate
  - getCenterY
```
public int getCenterY()
```
    Returns the character's hit box's center y-coordinate.
    
    Returns:
    
    the character's hit box's center y-coordinate
  - getSpeedX
```
public int getSpeedX()
```
    Returns the character's horizontal speed.
    
    Returns:
    
    the character's horizontal speed
  - getSpeedY
```
public int getSpeedY()
```
    Returns the character's vertical speed.
    
    Returns:
    
    the character's vertical speed
  - getState
```
public State getState()
```
    Returns the character's state: STAND / CROUCH/ AIR / DOWN.
    
    Returns:
    
    the character's state: STAND / CROUCH/ AIR / DOWN
    
    See Also:
    
    State
  - getAction
```
public Action getAction()
```
    Returns the character's action.
    
    Returns:
    
    the character's action
    
    See Also:
    
    Action
  - getRemainingFrame
```
public int getRemainingFrame()
```
    Returns the number of frames that the character needs to resume to its normal status.
    
    Returns:
    
    the number of frames that the character needs to resume to its normal status
  - getAttack
```
public AttackData getAttack()
```
    Returns the attack data that the character is using.
    
    Returns:
    
    the attack data that the character is using
    
    See Also:
    
    AttackData
  - getGraphicSizeX
```
public int getGraphicSizeX()
```
    Returns the character's graphic width.
    
    Returns:
    
    the character's graphic width
  - getGraphicSizeY
```
public int getGraphicSizeY()
```
    Returns the character's graphic height.
    
    Returns:
    
    the character's graphic height
  - getGraphicAdjustX
```
public int getGraphicAdjustX()
```
    Returns the amount of movement in the horizontal direction used to adjust the x coordinate when determining the direction of the character.
    
    Returns:
    
    the amount of movement in the horizontal direction used to adjust the x coordinate
  - isHitConfirm
```
public boolean isHitConfirm()
```
    Returns the flag whether the motion hits the opponent or not.
    
    Returns:
    
    true if the motion hits the opponent, false otherwise
  - getHitCount
```
public int getHitCount()
```
    Returns the continuous hit count of attacks used by this character.
    
    Returns:
    
    the continuous hit count of attacks used by this character
  - getLastHitFrame
```
public int getLastHitFrame()
```
    Returns the frame number of the last frame that an attack used by this character hit the opponent.
    
    Returns:
    
    the frame number of the last frame that an attack used by this character hit the opponent
  - getInputCommand
```
public java.util.Deque<Key> getInputCommand()
```
    Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
    
    Returns a list storing keys of the action that the character will be executing in the simulator.
    
    Returns:
    
    a list storing keys of the action that the character will be executing in the simulator
  - getProcessedCommand
```
public java.util.Deque<Key> getProcessedCommand()
```
    Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
    
    Returns a list storing up to 30 keys that the character executed in the simulator.
    
    Returns:
    
    a list storing up to 30 keys that the character executed in the simulator
  - setHp
```
public void setHp(int hp)
```
    Sets the character's HP.
    
    Parameters:
    
    hp - the amount of HP
  - setEnergy
```
public void setEnergy(int energy)
```
    Sets the character's energy.
    
    Parameters:
    
    energy - the amount of energy
  - setX
```
public void setX(int x)
```
    Sets the character's horizontal position.
    
    Parameters:
    
    x - the character's horizontal position
  - setY
```
public void setY(int y)
```
    Sets the character's vertical position.
    
    Parameters:
    
    y - the character's vertical position
  - setSpeedX
```
public void setSpeedX(int speedX)
```
    Sets the character's horizontal speed.
    
    Parameters:
    
    speedX - the character's horizontal speed
  - setSpeedY
```
public void setSpeedY(int speedY)
```
    Sets the character's vertical speed.
    
    Parameters:
    
    speedY - the character's vertical speed
  - setState
```
public void setState(State state)
```
    Sets the character's state.
    
    Parameters:
    
    state - a given state
    
    See Also:
    
    State
  - setAction
```
public void setAction(Action action)
```
    Sets the character's action.
    
    Parameters:
    
    action - a given action
    
    See Also:
    
    Action
  - setFront
```
public void setFront(boolean front)
```
    Sets the character's facing direction.
    
    Parameters:
    
    front - the character's facing direction. true if the character is facing right, false otherwise.
  - setControl
```
public void setControl(boolean control)
```
    Sets the flag whether this character can run a new motion with the motion's command.
    
    Parameters:
    
    control - the flag whether this character can run a new motion with the motion's command. true if the character can run, false otherwise.
  - setRemainingFrame
```
public void setRemainingFrame(int remainingFrame)
```
    Sets the number of frames that the character needs to resume to its normal status.
    
    Parameters:
    
    remainingFrame - the number of frames that the character needs to resume to its normal status you want to set
  - setTop
```
public void setTop(int top)
```
    Sets the character's hit box's most-top y-coordinate
    
    Parameters:
    
    top - the integer value you want to set
  - setBottom
```
public void setBottom(int bottom)
```
    Sets the character's hit box's most-bottom y-coordinate
    
    Parameters:
    
    bottom - the integer value you want to set
  - setLeft
```
public void setLeft(int left)
```
    Sets the character's hit box's most-left x-coordinate
    
    Parameters:
    
    left - the character's hit box's most-left x-coordinate you want to set
  - setRight
```
public void setRight(int right)
```
    Sets the character's hit box's most-right x-coordinate.
    
    Parameters:
    
    right - the character's hit box's most-right x-coordinate you want to set
  - setAttack
```
public void setAttack(AttackData attack)
```
    Sets the character's attack.
    
    Parameters:
    
    attack - the attack you want to set
    
    See Also:
    
    AttackData
  - setHitCount
```
public void setHitCount(int hitCount)
```
    Sets the continuous hit count of attacks used by this character.
    
    Parameters:
    
    hitCount - the continuous hit count of attacks used by this character
  - setLastHitFrame
```
public void setLastHitFrame(int lastHitFrame)
```
    Sets the frame number of the last frame that an attack used by this character hit the opponent.
    
    Parameters:
    
    lastHitFrame - the frame number of the last frame that an attack used by this character hit the opponent
  - setHitConfirm
```
public void setHitConfirm(boolean hitConfirm)
```
    Sets a boolean value whether the motion hits the opponent or not.
    
    Parameters:
    
    hitConfirm - a boolean value whether the motion hits the opponent or not. true if the motion hits the opponent, false otherwise.
  - setInputCommand
```
public void setInputCommand(java.util.Deque<Key> inputCommand)
```
    Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
    
    Sets a list storing keys of the action that the character will be executing in the simulator.
    
    Parameters:
    
    inputCommand - a list storing keys of the action that the character will be executing in the simulator
  - setProcessedCommand
```
public void setProcessedCommand(java.util.Deque<Key> inputCommand)
```
    Deprecated. This method is used only for processing of the simulator. You should not use this method for AI development.
    
    Sets a list storing up to 30 keys that the character executed in the simulator.
    
    Parameters:
    
    inputCommand - a list storing up to 30 keys that the character executed in the simulator

Class CharacterData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CharacterData

CharacterData

Method Detail

isPlayerNumber

isFront

isControl

getHp

getEnergy

getX

getY

getLeft

getRight

getTop

getBottom

getCenterX

getCenterY

getSpeedX

getSpeedY

getState

getAction

getRemainingFrame

getAttack

getGraphicSizeX

getGraphicSizeY

getGraphicAdjustX

isHitConfirm

getHitCount

getLastHitFrame

getInputCommand

getProcessedCommand

setHp

setEnergy

setX

setY

setSpeedX

setSpeedY

setState

setAction

setFront

setControl

setRemainingFrame

setTop

setBottom

setLeft

setRight

setAttack

setHitCount

setLastHitFrame

setHitConfirm

setInputCommand

setProcessedCommand