SM_Help Class Reference

A State that contains and runs the Help Menu. More...

#include <SM_Help.h>

Inheritance diagram for SM_Help:

Collaboration diagram for SM_Help:

Public Member Functions
	SM_Help (S_StateManager *stateManager, SDL_Renderer *renderer, C_Vec2 dimensions, C_Music *backgroundMusic)
	Constructs the State object. More...
	~SM_Help ()
	Destructs the State object. More...
bool	input ()
	Handles the State input. More...
void	update (float dt)
	A function to update the State. More...
void	draw ()
	A function to draw the State to the screen. More...
Public Member Functions inherited from S_State
	S_State (S_StateManager *stateManager, SDL_Renderer *renderer, C_Vec2 dimensions)
	Constructs the State object. More...
virtual	~S_State ()
	A virtual destructor for the State object. More...

Private Attributes
C_Music *	backgroundMusic
	The background music. More...
float *	universalSpeed
	A pointer for the universal speed of the menu. More...
C_Texture *	buttonBackground
	The Button Background Image. More...
C_Texture *	help
	The help image. More...
UI_Button *	resumeButton
	The Resume Button. More...
UI_Button *	exitButton
	The Exit Button. More...
C_Texture *	coin
	The Coin Image. More...
C_Vec2	coinDim
	The dimensions of the coin image. More...
float	buttonYPos

Additional Inherited Members
Protected Attributes inherited from S_State
S_StateManager *	stateManager
	A pointer to the state manager. More...
SDL_Renderer *	renderer
	A pointer to the renderer. More...
C_Vec2	dimensions
	The screen dimensions. More...

Detailed Description

A State that contains and runs the Help Menu.

Author

Jamie Slowgrove

Constructor & Destructor Documentation

SM_Help::SM_Help	(	S_StateManager *	stateManager,
		SDL_Renderer *	renderer,
		C_Vec2	dimensions,
		C_Music *	backgroundMusic
	)

Constructs the State object.

Parameters

stateManager	A pointer to the StateManager.
renderer	A pointer to the renderer.
dimensions	The screen dimensions.
backgroundMusic	The background music of the State.

SM_Help::~SM_Help

(

)

Destructs the State object.

Member Function Documentation

void SM_Help::draw ( )

virtual

A function to draw the State to the screen.

Implements S_State.

Here is the call graph for this function:

bool SM_Help::input ( )

virtual

Handles the State input.

Returns

If false then quit the State.

Implements S_State.

Here is the call graph for this function:

void SM_Help::update ( float  dt )

virtual

A function to update the State.

Parameters

dt	The delta time.

Implements S_State.

Here is the call graph for this function:

Member Data Documentation

C_Music* SM_Help::backgroundMusic

private

The background music.

C_Texture* SM_Help::buttonBackground

private

The Button Background Image.

float SM_Help::buttonYPos

private

C_Texture* SM_Help::coin

private

The Coin Image.

C_Vec2 SM_Help::coinDim

private

The dimensions of the coin image.

UI_Button* SM_Help::exitButton

private

The Exit Button.

C_Texture* SM_Help::help

private

The help image.

UI_Button* SM_Help::resumeButton

private

The Resume Button.

float* SM_Help::universalSpeed

private

A pointer for the universal speed of the menu.

---

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

• SkyZoneOmegaPC/States/Menus/SM_Help.h
• SkyZoneOmegaPC/States/Menus/SM_Help.cpp