Help Class Reference

Creates a Help object that inherits JAM_State. Creates a Help object that inherits JAM_State and runs the Help. More...

#include <Help.h>

Inheritance diagram for Help:

Collaboration diagram for Help:

Public Member Functions
	Help (JAM_StateManager *stateManager, SDL_Renderer *renderer, int screenWidth, int screenHeight, JAM_Audio *music)
	~Help ()
bool	input ()
void	update (float deltaTime)
void	draw ()
Public Member Functions inherited from JAM_State
	JAM_State (JAM_StateManager *stateManager, SDL_Renderer *renderer, int screenWidth, int screenHeight)
virtual	~JAM_State ()

Private Member Functions
bool	windowsInput (SDL_Event &incomingEvent)
bool	androidInput (SDL_Event &incomingEvent)

Private Attributes
std::vector< JAM_Text * >	text
JAM_Audio *	music
JAM_Texture *	background

Additional Inherited Members
Protected Attributes inherited from JAM_State
JAM_StateManager *	stateManager
SDL_Renderer *	renderer
int	screenWidth
int	screenHeight

Detailed Description

Creates a Help object that inherits JAM_State. Creates a Help object that inherits JAM_State and runs the Help.

Author

Jamie Slowgrove

Constructor & Destructor Documentation

Help::Help	(	JAM_StateManager *	stateManager,
		SDL_Renderer *	renderer,
		int	screenWidth,
		int	screenHeight,
		JAM_Audio *	music
	)

Constructs the Help object.

Parameters

stateManager	A pointer to the StateManager.
renderer	A pointer to the renderer.
screenWidth	The screen width.
screenHeight	The screen height.
music	A pointer to the music.

Here is the call graph for this function:

Help::~Help

(

)

Destructs the Help object.

Member Function Documentation

bool Help::androidInput ( SDL_Event &  incomingEvent )

private

Handles the Android Game input.

Parameters

incomingEvent

A reference to the incoming SDL event.

Returns

If false then quit the Game State.

Here is the call graph for this function:

Here is the caller graph for this function:

void Help::draw ( )

virtual

A function to draw to the screen.

Implements JAM_State.

Here is the call graph for this function:

bool Help::input ( )

virtual

Handles the Help input.

Returns

If false the quit the Help State.

Implements JAM_State.

Here is the call graph for this function:

void Help::update ( float  deltaTime )

virtual

A function to update the Help to allow the Help to run.

Parameters

dt	The delta time.

Implements JAM_State.

Here is the call graph for this function:

bool Help::windowsInput ( SDL_Event &  incomingEvent )

private

Handles the Windows Game input.

Parameters

incomingEvent

A reference to the incoming SDL event.

Returns

If false then quit the Game State.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

JAM_Texture* Help::background

private

The background image.

JAM_Audio* Help::music

private

A pointer to the music.

std::vector<JAM_Text *> Help::text

private

The text.

---

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

• jni/src/Help.h
• jni/src/Help.cpp