FrameData

java.lang.Object
- struct.FrameData

```
public class FrameData
extends java.lang.Object
```
The class dealing with the information in the game such as the current frame number, number of rounds and character information.

Constructor Summary

Constructors
Constructor and Description
`FrameData()` The class constructor.
`FrameData(CharacterData[] characterData, int currentFrame, int currentRound, java.util.Deque<AttackData> projectileData)` The class constructor that creates a new instance of the FrameData class by copying the data passed as the arguments.
`FrameData(FrameData frameData)` A copy constructor that creates a copy of an instance of the FrameData class by copying the values of the variables from an instance of the FrameData class passed as the argument.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CharacterData`	`getCharacter(boolean playerNumber)` Returns an instance of the CharacterData class of the player specified by an argument.
`int`	`getDistanceX()` Returns the horizontal distance between P1 and P2.
`int`	`getDistanceY()` Returns the vertical distance between P1 and P2.
`boolean`	`getEmptyFlag()` Returns true if this instance is empty, false if it contains meaningful data.
`int`	`getFramesNumber()` Returns the number of frames since the beginning of the round.
`java.util.Deque<AttackData>`	`getProjectiles()` Returns the projectile data of both characters.
`java.util.Deque<AttackData>`	`getProjectilesByP1()` Returns the projectile data of player 1.
`java.util.Deque<AttackData>`	`getProjectilesByP2()` Returns the projectile data of player 2.
`int`	`getRemainingFramesNumber()` Returns the number of remaining frames of the round.
`int`	`getRemainingTime()` Deprecated. Use `getRemainingTimeMilliseconds()` instead. This method has been renamed to more clearly reflect its purpose.
`int`	`getRemainingTimeMilliseconds()` Returns the expected remaining time in milliseconds of the current round.
`int`	`getRound()` Returns the current round number.

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

- Constructor Detail
  - FrameData
```
public FrameData()
```
    The class constructor.
  - FrameData
```
public FrameData(CharacterData[] characterData,
                 int currentFrame,
                 int currentRound,
                 java.util.Deque<AttackData> projectileData)
```
    The class constructor that creates a new instance of the FrameData class by copying the data passed as the arguments.
    
    Parameters:
    
    characterData - an instance of the CharacterData class
    
    currentFrame - the frame number of the current frame
    
    currentRound - the round number of the current round
    
    projectileData - the queue that stores information on projectiles of P1 and P2
    
    See Also:
    
    CharacterData, KeyData
  - FrameData
```
public FrameData(FrameData frameData)
```
    A copy constructor that creates a copy of an instance of the FrameData class by copying the values of the variables from an instance of the FrameData class passed as the argument.
    
    Parameters:
    
    frameData - an instance of the FrameData class
- Method Detail
  - getCharacter
```
public CharacterData getCharacter(boolean playerNumber)
```
    Returns an instance of the CharacterData class of the player specified by an argument.
    
    Parameters:
    
    playerNumber - the number of the player. true if the player is P1, or false if P2.
    
    Returns:
    
    an instance of the CharacterData class of the player
  - getRemainingTimeMilliseconds
```
public int getRemainingTimeMilliseconds()
```
    Returns the expected remaining time in milliseconds of the current round.
    When FightingICE was launched with the training mode, this method returns the max value of integer.
    
    Returns:
    
    the expected remaining time in milliseconds of the current round
  - getRemainingTime
```
public int getRemainingTime()
```
    Deprecated. Use getRemainingTimeMilliseconds() instead. This method has been renamed to more clearly reflect its purpose.
    
    Returns the expected remaining time in seconds of the current round.
    When FightingICE was launched with the training mode, this method returns the max value of integer.
    
    Returns:
    
    the expected remaining time in seconds of the current round
  - getRemainingFramesNumber
```
public int getRemainingFramesNumber()
```
    Returns the number of remaining frames of the round.
    When FightingICE was launched with the training mode, this method returns the max value of integer.
    
    Returns:
    
    the number of remaining frames of the round
  - getFramesNumber
```
public int getFramesNumber()
```
    Returns the number of frames since the beginning of the round.
    
    Returns:
    
    the number of frames since the beginning of the round
  - getRound
```
public int getRound()
```
    Returns the current round number.
    
    Returns:
    
    the current round number
  - getProjectiles
```
public java.util.Deque<AttackData> getProjectiles()
```
    Returns the projectile data of both characters.
    
    Returns:
    
    the projectile data of both characters
  - getProjectilesByP1
```
public java.util.Deque<AttackData> getProjectilesByP1()
```
    Returns the projectile data of player 1.
    
    Returns:
    
    the projectile data of player 1
  - getProjectilesByP2
```
public java.util.Deque<AttackData> getProjectilesByP2()
```
    Returns the projectile data of player 2.
    
    Returns:
    
    the projectile data of player 2
  - getEmptyFlag
```
public boolean getEmptyFlag()
```
    Returns true if this instance is empty, false if it contains meaningful data.
    
    Returns:
    
    true if this instance is empty, or false if it contains meaningful data
  - getDistanceX
```
public int getDistanceX()
```
    Returns the horizontal distance between P1 and P2.
    
    Returns:
    
    the horizontal distance between P1 and P2
  - getDistanceY
```
public int getDistanceY()
```
    Returns the vertical distance between P1 and P2.
    
    Returns:
    
    the vertical distance between P1 and P2

Class FrameData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FrameData

FrameData

FrameData

Method Detail

getCharacter

getRemainingTimeMilliseconds

getRemainingTime

getRemainingFramesNumber

getFramesNumber

getRound

getProjectiles

getProjectilesByP1

getProjectilesByP2

getEmptyFlag

getDistanceX

getDistanceY