final/doc/index.md

25 lines
652 B
Markdown

# Function Overview
This document intended to assist developers who seek to extend the game by modifying source code in src/.
## Classes
### BackgroundImage
Its constructor takes the following arguments:
`int x, int y, BufferedImage backgroundImage, int width, int height, int parallaxRatio`
Draws a background image that moves one pixel every `parallaxRatio` pixels when `BackgroundImage.draw()` is called.
### Camera
placeholder
## Utility Functions
These functions are located in the `public final` class UtilityFunction; please note that the UtilityFunction constructor is private to prevent initialization.
### readFromFile
placeholder