A game module. More...

#include <Module.h>

Inheritance diagram for Module:

Public Member Functions
virtual	~Module ()
	Destructor. More...

virtual void	Input (const VGears::Event &event)=0
	Handles an input event. More...

virtual void	Update ()=0
	Updates the module state. More...

void	SetState (const MODULE_STATE state)
	Sets the module state. More...

const MODULE_STATE	GetState () const
	Retrieves the module state. More...

Private Attributes
MODULE_STATE	state_
	The current module state. More...

Detailed Description

A game module.

Constructor & Destructor Documentation

◆ ~Module()

virtual Module::~Module ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ GetState()

const MODULE_STATE Module::GetState ( ) const

inline

Retrieves the module state.

Returns: The module's current state.

◆ Input()

virtual void Module::Input ( const VGears::Event & event )

pure virtual

Handles an input event.

Implemented in ViewerModule.

◆ SetState()

void Module::SetState ( const MODULE_STATE state )

inline

Sets the module state.

Parameters

[in] state Module's new state.

◆ Update()

virtual void Module::Update ( )

pure virtual

Updates the module state.

Implemented in ViewerModule.

Member Data Documentation

◆ state_

MODULE_STATE Module::state_

private

The current module state.

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

src/core/Module.h

Public Member Functions

Private Attributes