Used for Window objects of all kinds. More...

#include <Window.h>

Inheritance diagram for RPG::Window:

Public Member Functions
	Window ()
	Experimental.

	~Window ()
	Experimental.

void	create (int width, int height, int x, int y, bool startHidden)
	Experimental.

void	redraw ()
	Experimental.

void	updateCursor (int choice)
	Experimental.

void	clear ()
	Clears the specified window of any text, so that it can be drawn on again.

void	refresh ()
	Experimental.

void	destroy ()
	Removes the specified window object and all of its components.

void	drawString (int x, int y, std::string text, int color, bool initialize)
	Built-in RM2k3 function that draws a string to a Window. (experimental)

int	getSelected ()
	Gets the index of a selection within a RPG::Window object (Example: int selected = RPG::battleData->winMonTarget->getSelected())

Public Attributes
int	choicesPerRow
	The number of choices per row.

Image *	image
	The actual image of the window after it's been drawn.

Image *	imageFrame
	The window's frame & background (if redrawn).

Image *	imageText
	The window's text (if redrawn), but can only draw underneath.

int	x
	The window's x-position.

int	y
	The window's y-position.

int	width
	The window's width.

int	height
	The window's height.

int	jumpX
	Change in x-position when moving cursor.

int	jumpY
	Change in y-position when moving cursor.

int	rowsPerPage
	Number of text rows on the window (choices or plain text)

int	cursorX
	The cursor's starting x-position (upper-left choice)

int	cursorY
	The cursor's starting y-position (upper-left choice)

int	cursorWidth
	The width of the cursor.

int	cursorHeight
	The height of the cursor.

int	totalChoices
	The total number of choices in the window.

int	currentChoice
	The current choice selected (zero-based)

int	currentScroll
	Amount of choices above current choice.

int	scrollTimer
	The timer between cursor movements (-12 or 12, minus or plus 4 each frame until it's 0)

bool	choiceVisible
	Has the choice bar been drawn? (It can still be considered visible if another window is active)

bool	choiceActive
	Is the choice bar of the window active?

int	choiceTimer
	The number of frames the choice has been selected.

int	rollOn1

int	rollOn2

int	winTimer
	The total number of frames the window has been visible before a RPG::Scene change.

DListPtr< char > *	text
	The window's text (doesn't work yet)

int	fontSet
	The window's font set?

Detailed Description

Used for Window objects of all kinds.

See also: RPG::SceneMenu; RPG::SceneShop; RPG::SceneTitle; RPG::SceneDebug

Member Function Documentation

◆ clear()

void RPG::Window::clear ( )

Clears the specified window of any text, so that it can be drawn on again.

Experimental

◆ create()

void RPG::Window::create	(	int	width,
		int	height,
		int	x,
		int	y,
		bool	startHidden )

Experimental.

Parameters

width	The width of the window
height	The height of the window
x	The X-coordinate of the window, based on the upper-left
y	The Y-coordinate of the window, based on the upper-left
startHidden	Start the window hidden?

◆ destroy()

void RPG::Window::destroy ( )

Removes the specified window object and all of its components.

Experimental

◆ getSelected()

int RPG::Window::getSelected ( )

Gets the index of a selection within a RPG::Window object (Example: int selected = RPG::battleData->winMonTarget->getSelected())

Returns: the zero-based index of the selection, or -1 if the RPG::Window object is not active

Member Data Documentation

◆ choicesPerRow

int RPG::Window::choicesPerRow

The number of choices per row.

Note: The Items window has 2.

The documentation for this class was generated from the following file:

include/DynRPG/Window.h

Public Member Functions

Public Attributes