Index

A B C D E F G H I J K M N O P Q R S T U W Y 
All Classes and Interfaces|All Packages

A

addSprite(Sprite) - Method in class World
Adds a Sprite to the World
addSpriteCopy(Sprite) - Method in class World
Adds a copy of a Sprite to the World
addSpriteCopyTo(Sprite, float, float) - Method in class World
Adds a copy of a Sprite to a specific coordinate in the World
addSpriteCopyTo(Sprite, float, float, float) - Method in class World
Adds a copy of an Animated Sprite to a specific coordinate in the World
animate() - Method in class AnimatedSprite
Cycles through the images of the animated sprite
animate(float) - Method in class AnimatedSprite
Cycles through the images of the animated sprite & reset a new animation speed
AnimatedSprite - Class in Unnamed Package
Animated Sprite class - useful to have Sprites move around Designed to be used with Spritesheets & JSON Array files from TexturePacker software: https://free-tex-packer.com/app/ Inspired by Daniel Shiffman's p5js Animated Sprite tutorial: https://youtu.be/3noMeuufLZY
AnimatedSprite(PApplet, String, String) - Constructor for class AnimatedSprite
Constructor #3 taking in images and json only
AnimatedSprite(PApplet, String, String, float, float) - Constructor for class AnimatedSprite
Constructor #2: animations + starting coordinates
AnimatedSprite(PApplet, String, String, float, float, float) - Constructor for class AnimatedSprite
Constructor #1 for AnimatedSprite with Spritesheet (Must use the TexturePacker to make the JSON)
animateHorizontal(float, float, boolean) - Method in class AnimatedSprite
Makes the AnimatedSprite move to the right-left
animateMove(float, float, boolean) - Method in class AnimatedSprite
Makes animated sprite move in any straight line
animateMove(float, float, float, boolean) - Method in class AnimatedSprite
Makes animated sprite move in any straight line + sets animation speed
animateTileSprite(GridLocation) - Method in class Grid
Checks for an AnimatedSprite and animates it
animateToPlayer(AnimatedSprite, float, boolean) - Method in class AnimatedSprite
Makes the AnimatedSprite move in the direction of another AnimatedSprite
animateVertical(float, float, boolean) - Method in class AnimatedSprite
Makes the AnimatedSprite move up-down

B

BLACK - Static variable in class PColor
 
BLUE - Static variable in class PColor
 
Button - Class in Unnamed Package
Button Class - Used to add a button into a Game
Button(PApplet, String, float, float, float, float, String) - Constructor for class Button
 

C

captureTile(int) - Method in class GridTile
 
checkCollision(GridLocation, GridLocation) - Method in class Game
 
checkIsCaptured() - Method in class GridTile
 
claimHexLocation(HexLocation) - Method in class HexGrid
 
clearAllSprites() - Method in class World
Removes all current Sprites from World (useful for restarting a level)
clearGrid() - Method in class Grid
Clears the screen from all Images & Sprites
clearTileImage(GridLocation) - Method in class Grid
Clears the tile image
clearTileSprite(GridLocation) - Method in class Grid
Clears the image from a particular tile
copy() - Method in class Sprite
Copies a new Sprite to same location as this Sprite
copySprite() - Method in class AnimatedSprite
Copies an AnimatedSprite
copyTo(float, float) - Method in class AnimatedSprite
Copies an AnimatedSprite to a specific location
copyTo(float, float) - Method in class Sprite
Copies a Sprite to a specific location
copyTo(float, float, float) - Method in class AnimatedSprite
Copies an AnimatedSprite to a specific location with a new speed
CYAN - Static variable in class PColor
 
CycleTimer - Class in Unnamed Package
CycleTimer Class - Used for create repeating timers
CycleTimer(PApplet, long) - Constructor for class CycleTimer
 

D

displayHexGrid() - Method in class HexGrid
 
distToRightEdge() - Method in class Screen
 
doesCollideBottom(Sprite, float) - Method in class Sprite
Checks if collision occurs at the bottom of this Sprite
draw() - Method in class Game
 

E

endGame() - Method in class Game
 
equals(GridLocation) - Method in class GridLocation
 
equals(HexLocation) - Method in class HexLocation
 
equals(PApplet, int, int) - Method in class PColor
 
equals(Sprite) - Method in class Sprite
Checks if this Sprite is same as otherSprite (based on name or image)

F

fillOneHex(HexTile) - Method in class HexGrid
 

G

Game - Class in Unnamed Package
 
Game() - Constructor for class Game
 
get(int, int, int) - Static method in class PColor
 
get(String) - Static method in class PColor
 
getAccelerationX() - Method in class Sprite
 
getAccelerationY() - Method in class Sprite
 
getBgImage() - Method in class Screen
Gets the background as a PImage
getBlue(PApplet, int) - Static method in class PColor
 
getCenterPixels() - Method in class HexTile
 
getCenterX() - Method in class Sprite
 
getCenterX(GridLocation) - Method in class Grid
 
getCenterY() - Method in class Sprite
 
getCenterY(GridLocation) - Method in class Grid
 
getChar(String) - Static method in class Input
 
getCol() - Method in class GridLocation
 
getColliders(Sprite) - Method in class World
Checks all Sprites for collisions with one specific Sprite
getColor() - Method in class GridTile
 
getColor() - Method in class Platform
Accessor method
getCycleTime() - Method in class CycleTimer
 
getDouble(String) - Static method in class Input
 
getFillColor(HexLocation) - Method in class HexGrid
 
getFloat(String) - Static method in class Input
 
getGameTime() - Method in class CycleTimer
 
getGreen(PApplet, int) - Static method in class PColor
 
getGridLocation() - Method in class Grid
 
getH() - Method in class Sprite
 
getHexString(int) - Static method in class PColor
 
getHexTile(HexLocation) - Method in class HexGrid
 
getImage() - Method in class GridTile
 
getImage() - Method in class Sprite
Accesses the Sprite's image
getImagePath() - Method in class Sprite
Gets the image path of the Sprite
getInt(String) - Static method in class Input
 
getIsAnimated() - Method in class Sprite
Checks if Sprite object is animated
getIsMoveable() - Method in class Screen
Checks if the Screen's background is moveable
getJsonFile() - Method in class AnimatedSprite
Accessor method
getLeftX() - Method in class Screen
Returns the pixel value for the left edge of the background image
getLocation() - Method in class GridTile
 
getLong(String) - Static method in class Input
 
getMap() - Method in class HexGrid
 
getMark() - Method in class GridTile
 
getMark(GridLocation) - Method in class Grid
Gets the mark value at a location
getName() - Method in class Screen
Gets the name of the Screen to be used for debugging
getName() - Method in class Sprite
Compares 2 sprites by a name, will check the image file name if no name specified
getNoMark() - Method in class GridTile
 
getNumCols() - Method in class Grid
Accessor method
getNumCols() - Method in class HexGrid
 
getNumRows() - Method in class Grid
Accessor method
getNumRows() - Method in class HexGrid
 
getNumSprites() - Method in class World
 
getOutlineColor() - Method in class GridTile
 
getOutlineColor() - Method in class Platform
Accessor method
getPoly() - Method in class HexTile
 
getRadius() - Method in class HexTile
 
getRed(PApplet, int) - Static method in class PColor
 
getRGBString(PApplet, int) - Static method in class PColor
 
getRow() - Method in class GridLocation
 
getScreenTime() - Method in class Screen
 
getScreenTimeSeconds() - Method in class Screen
 
getSeconds(long) - Method in class CycleTimer
 
getSpeedX() - Method in class Sprite
Gets the speed of the Sprite in the X-direction
getSpeedY() - Method in class Sprite
Gets the speed of the Sprite in the Y-direction
getSprite() - Method in class GridTile
 
getSprite(int) - Method in class World
Gets a specific Sprite based on its index
getSprites() - Method in class World
 
getString(String) - Static method in class Input
 
getTile(int, int) - Method in class Grid
 
getTile(GridLocation) - Method in class Grid
Returns the GridTile object stored at a specified GridLocation
getTileColor(HexLocation) - Method in class HexGrid
 
getTileHeight() - Method in class Grid
Accessor method
getTileImage(GridLocation) - Method in class Grid
Returns the PImage associated with a particular GridTile
getTileOutlineColor(HexLocation) - Method in class HexGrid
 
getTileSprite(GridLocation) - Method in class Grid
Gets the Sprite from a specific GridTile
getTileWidth() - Method in class Grid
Accessor method
getTimerTime() - Method in class CycleTimer
 
getTimeSince(long) - Method in class Screen
 
getTopY() - Method in class Screen
Returns the pixel value for the top edge of the background image
getTotalTime() - Method in class Screen
 
getW() - Method in class Sprite
 
getX() - Method in class Sprite
 
getX(int, int) - Method in class Grid
 
getX(GridLocation) - Method in class Grid
Provides the x-pixel value given a GridLocation loc
getXCoord() - Method in class GridLocation
 
getXCoord() - Method in class HexLocation
 
getY() - Method in class Sprite
 
getY(int, int) - Method in class Grid
 
getY(GridLocation) - Method in class Grid
 
getYCoord() - Method in class GridLocation
 
getYCoord() - Method in class HexLocation
 
GRAY - Static variable in class PColor
 
GREEN - Static variable in class PColor
 
Grid - Class in Unnamed Package
Grid Class - Used for rectangular-tiled games A 2D array of GridTiles which can be marked Subclass of World that can show all Images & Sprites
Grid(PApplet) - Constructor for class Grid
Grid Constructor #1: Default constructor that creates a 3x3 Grid
Grid(PApplet, int, int) - Constructor for class Grid
Grid Construtor #2: Only accepts the number of rows & columns (Default for 2023)
Grid(PApplet, String, PImage, int, int) - Constructor for class Grid
Grid constructor #3: Sets background image + rows & cols
Grid(PApplet, String, PImage, String[][], int, int) - Constructor for class Grid
Grid constructor #4: Takeas in 2D String array parameter to set tile marks
GridLocation - Class in Unnamed Package
GridLocation class - helper class to store coordinates more easily
GridLocation(int, int) - Constructor for class GridLocation
 
GridTile - Class in Unnamed Package
GridTile class - Designed to be used within the Grid class GridTiles have distinguishable marks that will be printed out to the console for easy visualization of a 2D array GridTiles can indicate if they have been "captured", colored, or are displaying an image
GridTile(PApplet) - Constructor for class GridTile
 
GridTile(PApplet, GridLocation) - Constructor for class GridTile
 
GridTile(PApplet, String) - Constructor for class GridTile
 
GridTile(PApplet, String, GridLocation) - Constructor for class GridTile
 

H

hasImage() - Method in class GridTile
 
hasMark(GridLocation) - Method in class Grid
Checks if a location has a mark
hasSprite() - Method in class GridTile
 
hasTileImage(GridLocation) - Method in class Grid
 
hasTileSprite(GridLocation) - Method in class Grid
Checks if a Tile has a PImage
HexGrid - Class in Unnamed Package
HexGrid Class - useful for tile-based games with more flavor! Inspired from CSRessel's Catan Game & Emmanuel Suriel's Grid class https://github.com/CSRessel/catan/blob/master/src/gui/CatanBoard.java Adapted for Processing
HexGrid(PApplet) - Constructor for class HexGrid
 
HexGrid(PApplet, int) - Constructor for class HexGrid
 
HexLocation - Class in Unnamed Package
HexLocation Class HexLocations use x & y coordinate instead of row & column designations
HexLocation(int, int) - Constructor for class HexLocation
 
HexTile - Class in Unnamed Package
HexTile Class
HexTile(PApplet, int, int, float) - Constructor for class HexTile
 
HexTile(PApplet, HexLocation, float) - Constructor for class HexTile
 
highlightTile(HexLocation) - Method in class HexGrid
 

I

Input - Class in Unnamed Package
Input class - to have popup boxes for users to type data Modified from North Toronto Collegiate Institute, Gerry Heffernan: https://ntci.on.ca/compsci/hef/ics3/ch1/1_4.html
Input() - Constructor for class Input
 
isClicked() - Method in class Button
 
isCoveredWithPic() - Method in class GridTile
 
isDone() - Method in class CycleTimer
 
isGameOver() - Method in class Game
 
isMouseOverButton() - Method in class Button
 
isOverlapping(Sprite) - Method in class Sprite
Checks if the rectangle of this Sprite overlaps in any way with the rectangle of another
isSolid() - Method in class Sprite
Checks if a Sprite is solid
isTouchingBottom(Sprite) - Method in class Sprite
Checks if sprite has bumped into the bottom of another sprite
isTouchingBottom(Sprite, float) - Method in class Sprite
Checks if sprite has bumped into the bottom of another sprite with a specified cushion on bottom
isTouchingLeft(Sprite) - Method in class Sprite
Checks if sprite has bumped into the left side of another sprite
isTouchingLeft(Sprite, float) - Method in class Sprite
Checks if sprite has bumped into the left side of another sprite with a specified cushion on left
isTouchingRight(Sprite) - Method in class Sprite
Checks if sprite has landed on top of another sprite
isTouchingRight(Sprite, float) - Method in class Sprite
Checks if sprite has bumped into the right side of another sprite with a specified cushion on right
isTouchingTop(Sprite) - Method in class Sprite
Checks if sprite has landed on top of another sprite
isTouchingTop(Sprite, float) - Method in class Sprite
Checks if sprite has landed on top of another sprite with a specified cushion on top
isValid(HexLocation) - Method in class HexGrid
 
isValidLocation(HexLocation) - Method in class HexGrid
 
isWithinOne(HexLocation, HexLocation) - Method in class HexGrid
 
isWithinTwo(HexLocation, HexLocation) - Method in class HexGrid
 

J

jump() - Method in class Sprite
Creates a jump with default jump speed
jump(float) - Method in class Sprite
Creates a jump with a specific jumpSpeed at a pre-existing gravityStrength
jump(float, float) - Method in class Sprite
Creates a jump with a specific jumpSpeed and also sets the Sprite's gravity strength

K

keyPressed() - Method in class Game
 

M

MAGENTA - Static variable in class PColor
 
main(String[]) - Static method in class Main
 
Main - Class in Unnamed Package
 
Main() - Constructor for class Main
 
mouseClicked() - Method in class Game
 
move(float, float) - Method in class Sprite
Moves Sprite image on the screen relative to current position
moveBgXY(float, float) - Method in class Screen
Moves the background image in the X & Y directions
moveSprites() - Method in class Game
 
moveTo(float, float) - Method in class Sprite
Moves Sprite image on the screen to a specific coordinate

N

NULL - Static variable in class PColor
 

O

outlineOneHex(HexTile) - Method in class HexGrid
 

P

p - Variable in class Sprite
 
pause(int) - Method in class CycleTimer
 
pause(int) - Method in class Screen
Resets the timer for the screen.
PColor - Class in Unnamed Package
PColor class - provides static variables and methods for Processing colors
PColor() - Constructor for class PColor
 
Platform - Class in Unnamed Package
Platform class Can be used with the following tutorials: https://longbaonguyen.github.io/courses/platformer/platformer.html
Platform(PApplet, int, float, float, float, float) - Constructor for class Platform
Platform Constructor #2: Platform is a rectangle of color defined by it's center-x and top-Y positions
Platform(PApplet, PImage, float, float, float, float) - Constructor for class Platform
Platform Constructor #1: Platform is PImage defined by it's center-x and top-Y positions
populateSprites() - Method in class Game
 
printGrid() - Method in class Grid
Prints out the marks in the Grid to the console
printPColor(PApplet, int) - Static method in class PColor
 
printSprites() - Method in class World
Deprecated.
printWorldSprites() - Method in class World
Prints out list of Sprites

Q

question(String) - Static method in class Input
Generates a pop-up question on the Screen

R

RED - Static variable in class PColor
 
releaseTile() - Method in class GridTile
 
removeBackground() - Method in class HexGrid
Removes a regular background or moveable background, allowing setColor to work again.
removeHexLocation(HexLocation) - Method in class HexGrid
 
removeMark() - Method in class GridTile
 
removeMark(GridLocation) - Method in class Grid
Gets the mark value at a location
removeSprite(int) - Method in class World
Removes a sprite from the World based on its index in the ArrayList
removeSprite(Sprite) - Method in class World
Removes a Sprite from the world
resetCycleTime() - Method in class CycleTimer
 
resetTime() - Method in class Screen
 
resize(int, int) - Method in class AnimatedSprite
Resizes the animated sprite images to different dimensions
resize(int, int) - Method in class Sprite
Scales the Sprite's image size to a new width & height
rotate(float) - Method in class Sprite
Rotates Sprite image on the screen

S

Screen - Class in Unnamed Package
Screen class - a high level class that handles background screens & millisecond timing Has a World Subclass
Screen(PApplet, String, String, float, float, float) - Constructor for class Screen
Screen Constructor #2: For background images that move - Takes String (Coded as a Sprite, not a Processing background PImage)
Screen(PApplet, String, PImage) - Constructor for class Screen
Screen Constructor #1: Stationary background image
Screen(PApplet, String, PImage, float, float, float) - Constructor for class Screen
Screen Constructor #3: For background images that move - Takes PImage (Coded as a Sprite, not a Processing background PImage)
setAccelerationX(float) - Method in class Sprite
Changes the acceleration of the Sprite in the X-direction
setAccelerationY(float) - Method in class Sprite
Changes the acceleration of the Sprite in the Y-direction
setAllMarks(String[][]) - Method in class Grid
Sets the marks for an entire grid from a 2D String array tileMarks MUST match the same number of rows & columns as the grid
setAllOutlinesColor(int) - Method in class HexGrid
 
setAllTileColors(int) - Method in class HexGrid
 
setAllTileOutlines(int) - Method in class HexGrid
 
setAnimationSpeed(float) - Method in class AnimatedSprite
Mutator method
setBackground(PImage) - Method in class HexGrid
sets the background to imgName.
setBg(PImage) - Method in class Screen
Sets the background image for NON-MOVEABLE backgrounds
setButtonColor(int) - Method in class Button
 
setCenterX(float) - Method in class Sprite
 
setCenterY(float) - Method in class Sprite
 
setClickColor(Integer) - Method in class Button
 
setClickHighlight(boolean) - Method in class Button
 
setColor(int) - Method in class GridTile
 
setColor(int) - Method in class Platform
Mutator method
setCoveredWithPic(boolean) - Method in class GridTile
 
setFillColor(HexLocation, int) - Method in class HexGrid
 
setFontFactor(float) - Method in class Button
 
setFontStyle(String) - Method in class Button
 
setH(float) - Method in class Sprite
 
setHexCenterPixels(Point) - Method in class HexTile
 
setHexPoly(Polygon) - Method in class HexTile
 
setHoverColor(Integer) - Method in class Button
 
setHoverHighlight(boolean) - Method in class Button
 
setImage(PImage) - Method in class GridTile
 
setImage(PImage) - Method in class Sprite
Changes the Sprite's image
setIsAnimated(boolean) - Method in class Sprite
Changes if Sprite object is animated
setLeftX(float) - Method in class Screen
Moves the left edge of the background to a specified pixel (ie.
setMark(String) - Method in class GridTile
 
setMark(String, GridLocation) - Method in class Grid
Assigns a String mark to a location in the Grid.
setName(String) - Method in class Screen
Sets the name of the Screen to be used for debugging
setName(String) - Method in class Sprite
Sets the Sprites name to be used for comparisons
setNewMark(String) - Method in class GridTile
 
setNewMark(String, GridLocation) - Method in class Grid
Assigns a String mark to a location in the Grid.
setOutlineColor(int) - Method in class Button
 
setOutlineColor(int) - Method in class GridTile
 
setOutlineColor(int) - Method in class Platform
Mutator method
setShapeRounding(float) - Method in class Button
 
setSolid(boolean) - Method in class Sprite
Changes if a Sprite is solid
setSpeed(float) - Method in class AnimatedSprite
Sets the speed of how fast the frames cycle
setSpeed(float, float) - Method in class Sprite
Changes the speed of the Sprite
setSpeedX(float) - Method in class Sprite
 
setSpeedY(float) - Method in class Sprite
 
setSprite(Sprite) - Method in class GridTile
 
setText(String) - Method in class Button
 
setTextColor(int) - Method in class Button
 
setTileColor(HexLocation, int) - Method in class HexGrid
 
setTileImage(GridLocation, PImage) - Method in class Grid
Sets the image at a particular tile in the grid & displays it
setTileOutlineColor(HexLocation, int) - Method in class HexGrid
 
setTileSprite(GridLocation, Sprite) - Method in class Grid
Sets the Sprite at a particular tile in the grid & displays it
settings() - Method in class Game
 
setTopY(float) - Method in class Screen
Moves the top edge of the background to a specified pixel (ie.
setup() - Method in class Game
 
setVisible(boolean) - Method in class Button
 
setW(float) - Method in class Sprite
 
show() - Method in class AnimatedSprite
Overriden method Displays the correct frame of the Sprite image on the screen
show() - Method in class Button
 
show() - Method in class Grid
Displays all World + Screen + Grid visuals
show() - Method in class Platform
Displays the Platform on the Screen
show() - Method in class Screen
Updates all sprites and images on the Screen Does nothing unless Overridden by World, Grid, and HexGrid
show() - Method in class Sprite
Displays the Sprite image on the screen
show() - Method in class World
Displays all World + Screen visuals
showBg() - Method in class Screen
Updates any movement of the background to be shown
showGridImages() - Method in class Grid
Displays the PImages stored in ALL the GridTiles
showGridSprites() - Method in class Grid
Displays ALL the Sprites stored in the Grid
showImages() - Method in class Grid
Deprecated.
showSprites() - Method in class World
Deprecated.
showTileImage(GridLocation) - Method in class Grid
Displays the PImage at a specific location
showTileSprite(GridLocation) - Method in class Grid
Displays the Sprite on a single GridTile
showWorldSprites() - Method in class World
Displays all the Sprites on the screen
Sprite - Class in Unnamed Package
Sprite class - to create objects that move around with their own properties Inspired by Daniel Shiffman's p5js Animated Sprite tutorial Note: Picture coordinate origina at top, left corner
Sprite(PApplet, int, float, float, float, float) - Constructor for class Sprite
Sprite Constructor #6: Rectangle of color Sprite, used for Platform
Sprite(PApplet, String) - Constructor for class Sprite
Sprite Constructor #1: Only pass in the image file (Non-animated)
Sprite(PApplet, String, float) - Constructor for class Sprite
Sprite Constructor #2: Only pass in the image file that can be scaled (Non-animated)
Sprite(PApplet, String, float, float, float) - Constructor for class Sprite
Sprite Constructor #3: for Non-Animated Sprite (not working)
Sprite(PApplet, String, float, float, float, boolean) - Constructor for class Sprite
Sprite Constructor #4: for ANY Sprite from a file name
Sprite(PApplet, PImage, float, float, float) - Constructor for class Sprite
Sprite Constructor #5: Input a PImage directly, Used for moveable Sprites
startGravity() - Method in class Sprite
Starts gravity acting on a Sprite at default rate or previously defined rate
startGravity(float) - Method in class Sprite
Starts gravity acting on sprite at a particular acceleration rate
startPrintingGridMarks() - Method in class Grid
If Grid mark system is used, shows all marks in the Grid in the console
stopGravity() - Method in class Sprite
Stops gravity acting on a Sprite
stopPrintingGridMarks() - Method in class Grid
Turns off Grid mark system from printing all marks in the Grid in the console

T

toString() - Method in class Button
 
toString() - Method in class CycleTimer
 
toString() - Method in class GridLocation
 
toString() - Method in class GridTile
 
toString() - Method in class HexLocation
 
toString() - Method in class Platform
 
toString() - Method in class Screen
 
toString() - Method in class Sprite
 
toStringPImage(PImage) - Static method in class Util
 

U

update() - Method in class Sprite
Automatically moves the Sprite based on its velocity
update() - Method in class World
Updates all Sprites in the World each cycle
update(float) - Method in class Sprite
Method called to update a Sprite's position based on its set speed and acceleration
updateScreen() - Method in class Game
 
updateTitleBar() - Method in class Game
 
Util - Class in Unnamed Package
 
Util() - Constructor for class Util
 

W

WHITE - Static variable in class PColor
 
World - Class in Unnamed Package
World Class - Used to describe the screen of a pixel-based game Subclass of a Screen, includes an ArrayList of Sprite objects
World(PApplet) - Constructor for class World
World Constructor #3: Creates a default World
World(PApplet, String) - Constructor for class World
World Constructor #2: Creates a World with no background image
World(PApplet, String, String, float, float, float) - Constructor for class World
World Constructor #4 for Moveable Backgrounds Image can be scaled to be bigger so the background doesn't run out too quickly
World(PApplet, String, PImage) - Constructor for class World
World Constructor #1: Creates a World with the specificed background image

Y

YELLOW - Static variable in class PColor
 
A B C D E F G H I J K M N O P Q R S T U W Y 
All Classes and Interfaces|All Packages