controller.PaintBuilder

Class PaintBuilder

java.lang.Object

controller.PaintBuilder.PaintBuilder

public class PaintBuilder
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
int	colorRainbow
float	runTimeSeconds
java.lang.String	stringRunTime
float	timeScale

Constructor Summary

Constructors

Constructor and Description
PaintBuilder(int x, int y, int width)

Method Summary

Modifier and Type	Method and Description
void	addRow(RowBuilder rowInfo) Adds a row.
void	addSpacerRow(int rowHeight) Adds an empty row used to add a space between two rows.
void	draw() Draws the paint.
void	drawPlaceholderPaint()
int	getHeight() Get the paint's height
int	getRowsY() Get the paint's rowsY offset
int	getWidth() Get the paint's width
int	getX() Get the paint's top left X coordinate
int	getY() Get the paint's top left Y coordinate
void	setBackgroundColor(int color, int transparency) Adds a background of a specified color and transparency
void	setBorderColor(int color) Adds a border box of a specified color
void	setHeight(int newHeight) Set the paint's height to a new value
void	setRainbowSpeed(int speed) Set the speed of colorRainbow cycling.
void	setRowsY(int rowsY) Y offset of where to start drawing rows relative to the paint's top border.
void	setTitleCenteredSingleColor(java.lang.String string, int color, int yOffset) Adds a centered title header with a single color
void	setTitleMultipleColor(java.lang.String[] strings, int[] colors, int[] xOffsets, int yOffset) Adds a title header with a multiple colored strings
void	setTitleSingleColor(java.lang.String string, int color, int xOffset, int yOffset) Adds a title header with a single color
void	setWidth(int newWidth) Set the paint's width to a new value
void	setX(int x) Set the paint's top left X coordinate to a new value
void	setY(int y) Set the paint's top left Y coordinate to a new value
void	start(int x, int y, int width) Starts the PaintBuilder.
java.lang.String	stringAmountPerHour(int finished) Returns a string for amount of something per hour
java.lang.String	stringFormatInt(int amount) Takes an int, shortens it, and returns it as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stringRunTime

public java.lang.String stringRunTime

runTimeSeconds

public float runTimeSeconds

timeScale

public float timeScale

colorRainbow

public int colorRainbow

Constructor Detail

PaintBuilder

public PaintBuilder(int x,
                    int y,
                    int width)

Parameters:

width - int -- Width of the paint

x - int -- X coordinate for the top left corner of the paint

y - int -- Y coordinate for the top left corner of the paint

Method Detail

start

public void start(int x,
                  int y,
                  int width)

Starts the PaintBuilder. PaintBuilder will not draw a custom paint if this is not called. Place this at the beginning of start() in scripts.

Parameters:

width - int -- Width of the paint

x - int -- X coordinate for the top left corner of the paint

y - int -- Y coordinate for the top left corner of the paint

setX

public void setX(int x)

Set the paint's top left X coordinate to a new value

Parameters:

x - int -- New X value

setY

public void setY(int y)

Set the paint's top left Y coordinate to a new value

Parameters:

y - int -- New Y value

setRainbowSpeed

public void setRainbowSpeed(int speed)

Set the speed of colorRainbow cycling.

Parameters:

speed - int -- The speed at which colorRainbow updates. The default is speed 4.

setRowsY

public void setRowsY(int rowsY)

Y offset of where to start drawing rows relative to the paint's top border. Negative is up while positive is down.

Parameters:

rowsY - int -- New Y value

setWidth

public void setWidth(int newWidth)

Set the paint's width to a new value

Parameters:

newWidth - int -- New width value

setHeight

public void setHeight(int newHeight)

Set the paint's height to a new value

Parameters:

newHeight - int -- New height value

getX

public int getX()

Get the paint's top left X coordinate

Returns:

int

getY

public int getY()

Get the paint's top left Y coordinate

Returns:

int

getRowsY

public int getRowsY()

Get the paint's rowsY offset

Returns:

int

getWidth

public int getWidth()

Get the paint's width

Returns:

int

getHeight

public int getHeight()

Get the paint's height

Returns:

int

setBorderColor

public void setBorderColor(int color)

Adds a border box of a specified color

Parameters:

color - int -- Color of the border box. RGB "HTML" Color Example: 0x36E2D7

setBackgroundColor

public void setBackgroundColor(int color,
                               int transparency)

Adds a background of a specified color and transparency

Parameters:

color - int -- Color of the background. RGB "HTML" Color Example: 0x36E2D7

transparency - int -- Transparency of the background. 0 to 255.

setTitleSingleColor

public void setTitleSingleColor(java.lang.String string,
                                int color,
                                int xOffset,
                                int yOffset)

Adds a title header with a single color

Parameters:

string - String -- Title

color - int -- Title color RGB "HTML" Color Example: 0x36E2D7

xOffset - int -- X offset for the title from the paint's X

yOffset - int -- Y offset for the title from the paint's Y

setTitleMultipleColor

public void setTitleMultipleColor(java.lang.String[] strings,
                                  int[] colors,
                                  int[] xOffsets,
                                  int yOffset)

Adds a title header with a multiple colored strings

Parameters:

strings - String[] -- Array of strings

colors - int[] -- Array of colors for the title strings. RGB "HTML" Color Example: 0x36E2D7

xOffsets - int[] -- Array of offsets for each string's X from the previous string's X. The first index is the amount offset from the paint's border.

yOffset - int -- Y offset for the title's string from the paint's Y

setTitleCenteredSingleColor

public void setTitleCenteredSingleColor(java.lang.String string,
                                        int color,
                                        int yOffset)

Adds a centered title header with a single color

Parameters:

string - String -- Title

color - int -- Title color RGB "HTML" Color Example: 0x36E2D7

yOffset - int -- Y offset for the title from the paint's Y

addRow

public void addRow(RowBuilder rowInfo)

Adds a row.

Parameters:

rowInfo - RowBuilder -- Row information from controller.PaintBuilder.RowBuilder

addSpacerRow

public void addSpacerRow(int rowHeight)

Adds an empty row used to add a space between two rows.

stringAmountPerHour

public java.lang.String stringAmountPerHour(int finished)

Returns a string for amount of something per hour

Parameters:

finished - int -- Amount of actions/items gained in this session

Returns:

String

stringFormatInt

public java.lang.String stringFormatInt(int amount)

Takes an int, shortens it, and returns it as a string.

Example: 1230000 gets returned as 1.23M

Parameters:

amount - int -- Amount to shorten

Returns:

String

drawPlaceholderPaint

public void drawPlaceholderPaint()

draw

public void draw()

Draws the paint.