Character

java.lang.Object
- edu.ucsb.cs56.projects.games.pacman.Character

Direct Known Subclasses:

Ghost, PacPlayer
```
public abstract class Character
extends java.lang.Object
```
Class that every character inherits from, including players and AI-controlled enemies.

Version:

CS56, F17

Author:

Dario Castellanos Anaya, Daniel Ly, Kelvin Yang, Nicholas Duncan, Wei Tung Chen

Field Summary

Fields
Modifier and Type	Field	Description
`boolean`	`alive`
`java.lang.String`	`assetImagePath`
`int`	`deathTimer`
`int`	`dx`
`int`	`dy`
`int`	`lives`
`int`	`playerNum`
`int`	`reqdx`
`int`	`reqdy`
`int`	`speed`
`int`	`startX`
`int`	`startY`
`int`	`x`
`int`	`y`

Constructor Summary

Constructors
Constructor	Description
`Character(int x, int y)`	Constructor for Character class
`Character(int x, int y, int playerNum)`	Constructor for Character class

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract void`	`death()`	Handles character's death
`abstract void`	`draw(java.awt.Graphics2D g, javax.swing.JComponent canvas)`	draws the character onto the screen
`abstract java.awt.Image`	`getLifeImage()`	Returns the image used for displaying remaining lives
`abstract void`	`keyPressed(int key)`	Handles key presses for game controls
`abstract void`	`keyReleased(int key)`	Handles key releases for game controls
`abstract void`	`loadImages()`	Load game sprites from images folder
`void`	`move()`	Moves character's current position
`abstract void`	`move(Grid grid)`	Moves character's current position with the board's collision
`static boolean`	`moveable(int dx, int dy, short grid)`	Check if the direction has no wall and moveable
`abstract void`	`moveAI(Grid grid, Character[] c)`	Moves character's current position with the board's collision
`void`	`reset()`	Restores the character's default values.
`void`	`resetPos()`	Restores the character's default position
`void`	`setSpeed(int speed)`	sets the speed of the character
`void`	`setX(int x)`	sets the x-coordiante of the character on the screen
`void`	`setY(int y)`	sets the y-coordinate of the character on the screen

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

- Field Detail
  - alive
```
public boolean alive
```
  - assetImagePath
```
public java.lang.String assetImagePath
```
  - playerNum
```
public int playerNum
```
  - lives
```
public int lives
```
  - deathTimer
```
public int deathTimer
```
  - startX
```
public int startX
```
  - startY
```
public int startY
```
  - speed
```
public int speed
```
  - x
```
public int x
```
  - y
```
public int y
```
  - dx
```
public int dx
```
  - dy
```
public int dy
```
  - reqdx
```
public int reqdx
```
  - reqdy
```
public int reqdy
```
- Constructor Detail
  - Character
```
public Character(int x,
                 int y)
```
    Constructor for Character class
    
    Parameters:
    
    x - the starting x coordinate of pacman
    
    y - the starting y coordinate of pacman
  - Character
```
public Character(int x,
                 int y,
                 int playerNum)
```
    Constructor for Character class
    
    Parameters:
    
    x - the starting x coordinate of pacman
    
    y - the starting y coordinate of pacman
    
    playerNum - int representing who the player is controlling
- Method Detail
  - reset
```
public void reset()
```
    Restores the character's default values.
  - resetPos
```
public void resetPos()
```
    Restores the character's default position
  - draw
```
public abstract void draw(java.awt.Graphics2D g,
                          javax.swing.JComponent canvas)
```
    draws the character onto the screen
    
    Parameters:
    
    g - a Graphics2D object
    
    canvas - A JComponent object to be drawn on
  - loadImages
```
public abstract void loadImages()
```
    Load game sprites from images folder
  - death
```
public abstract void death()
```
    Handles character's death
  - getLifeImage
```
public abstract java.awt.Image getLifeImage()
```
    Returns the image used for displaying remaining lives
    
    Returns:
    
    Image of character
  - keyPressed
```
public abstract void keyPressed(int key)
```
    Handles key presses for game controls
    
    Parameters:
    
    key - Integer representing the key pressed
  - keyReleased
```
public abstract void keyReleased(int key)
```
    Handles key releases for game controls
    
    Parameters:
    
    key - Integer representing the key released
  - move
```
public abstract void move(Grid grid)
```
    Moves character's current position with the board's collision
    
    Parameters:
    
    grid - The Grid to be used for collision
  - moveAI
```
public abstract void moveAI(Grid grid,
                            Character[] c)
```
    Moves character's current position with the board's collision
    
    Parameters:
    
    grid - The Grid to be used for collision
    
    c - Array of target Characters
  - move
```
public void move()
```
    Moves character's current position
  - setX
```
public void setX(int x)
```
    sets the x-coordiante of the character on the screen
  - setY
```
public void setY(int y)
```
    sets the y-coordinate of the character on the screen
  - setSpeed
```
public void setSpeed(int speed)
```
    sets the speed of the character
  - moveable
```
public static boolean moveable(int dx,
                               int dy,
                               short grid)
```
    Check if the direction has no wall and moveable
    
    Parameters:
    
    dx - x-direction move
    
    dy - y-direction move
    
    grid - grid data
    
    Returns:
    
    true if the direction is moveable

Class Character

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

alive

assetImagePath

playerNum

lives

deathTimer

startX

startY

speed

x

y

dx

dy

reqdx

reqdy

Constructor Detail

Character

Character

Method Detail

reset

resetPos

draw

loadImages

death

getLifeImage

keyPressed

keyReleased

move

moveAI

move

setX

setY

setSpeed

moveable