Help Class Reference

A State that contains and runs the Demo. More...

#include <Help.h>

Inheritance diagram for Help:

Collaboration diagram for Help:

Public Member Functions
	Help (StateManager *stateManager, SDL_Window *window)
	Constructs the State object. More...
	~Help ()
	Destructs the State object. More...
bool	input ()
	Handles the State input. More...
void	update ()
	A function to update the State. More...
void	draw ()
	A function to draw the State to the screen. More...
Public Member Functions inherited from State
	State (StateManager *stateManager, SDL_Window *window, std::string name)
	Constructs a State object. More...
virtual	~State ()
	A virtual destructor for the State object. More...
SDL_Window *	getWindow ()
	Gets the window. More...
std::string	getName ()
	Gets the name of the state. More...
void	destroyState ()
	A function to destroy all data in a state. More...

Private Attributes
std::string	backgroundMusicID
	The background music id. More...
std::string	gameHelp
	The game help info. More...

Additional Inherited Members
Protected Attributes inherited from State
StateManager *	stateManager
	A pointer to the state manager. More...
SDL_Window *	window
	The window to display to. More...
std::string	name
	The state name. More...
bool	destroyed
	A boolean for if the state is destroyed. More...

Detailed Description

A State that contains and runs the Demo.

Constructor & Destructor Documentation

Help()

Help::Help	(	StateManager *	stateManager,
		SDL_Window *	window
	)

Constructs the State object.

Parameters

stateManager	A pointer to the StateManager.
window	A pointer to the window in use.

Here is the call graph for this function:

~Help()

Help::~Help

(

)

Destructs the State object.

Member Function Documentation

draw()

void Help::draw ( )

virtual

A function to draw the State to the screen.

Implements State.

Here is the call graph for this function:

input()

bool Help::input ( )

virtual

Handles the State input.

Returns

If false then quit the State.

Implements State.

Here is the call graph for this function:

update()

void Help::update ( )

virtual

A function to update the State.

Implements State.

Here is the call graph for this function:

Member Data Documentation

backgroundMusicID

std::string Help::backgroundMusicID

private

The background music id.

gameHelp

std::string Help::gameHelp

private

The game help info.

---

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

• LevelHEngine/States/CannonGame/States/Help.h
• LevelHEngine/States/CannonGame/States/Help.cpp