#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/gamestates/GSMainMenu.h>

Inheritance diagram for orxonox::GSMainMenu:

Public Member Functions
	GSMainMenu (const GameStateInfo &info)

	~GSMainMenu ()

virtual void	activate () override

virtual void	deactivate () override

const std::string &	getMainMenuSoundPath ()

void	reloadSound ()

void	setConfigValues ()

void	setMainMenuSoundPath (const std::string &path)

virtual void	update (const Clock &time) override

Public Member Functions inherited from orxonox::GameState
	GameState (const GameStateInfo &info)
	Constructor only initialises variables and sets the name permanently. More...

virtual	~GameState ()
	Destructor only checks that we don't delete an active state. More...

State	getActivity () const

const GameStateInfo &	getInfo () const

const std::string &	getName () const

Public Member Functions inherited from orxonox::Configurable
	Configurable ()

void	setConfigValues ()
	Function to collect the SetConfigValue-macro calls. More...

Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...

	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...

virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...

Context *	getContext () const

void	setContext (Context *context)
	Changes the context. More...

void	unregisterObject ()
	Removes this object from the object-lists. More...

Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...

virtual	~Identifiable ()

ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...

template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...

template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...

Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...

bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...

template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...

bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...

bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...

template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...

template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...

bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...

bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...

template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...

bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Static Public Member Functions
static void	startClient (const std::string &destination="")
	Connect to a game as client. More...

static void	startDedicated (const std::string &level="")
	Start a level in dedicated mode. More...

static void	startIOConsole ()

static void	startServer (const std::string &level="")
	Start a level in server mode. More...

static void	startStandalone (const std::string &level="")
	Start a level in standalone mode. More...

Private Attributes
AmbientSound *	ambient_

Ogre::Camera *	camera_

Scene *	scene_

std::string	soundPathMain_

Additional Inherited Members

Constructor & Destructor Documentation

orxonox::GSMainMenu::GSMainMenu ( const GameStateInfo & info )

orxonox::GSMainMenu::~GSMainMenu ( )

Member Function Documentation

void orxonox::GSMainMenu::activate ( )

overridevirtual

Reimplemented from orxonox::GameState.

void orxonox::GSMainMenu::deactivate ( )

overridevirtual

Reimplemented from orxonox::GameState.

const std::string & orxonox::GSMainMenu::getMainMenuSoundPath ( )

void orxonox::GSMainMenu::reloadSound ( )

void orxonox::GSMainMenu::setConfigValues ( void )

void orxonox::GSMainMenu::setMainMenuSoundPath ( const std::string & path )

void orxonox::GSMainMenu::startClient ( const std::string & destination = "" )

static

Connect to a game as client.

Parameters

destination The destination to connect to. If empty, the client connects to the default destination.

void orxonox::GSMainMenu::startDedicated ( const std::string & level = "" )

static

Start a level in dedicated mode.

Parameters

level The filename of the level to be started. If empty, the default level is started.

static void orxonox::GSMainMenu::startIOConsole ( )

static

void orxonox::GSMainMenu::startServer ( const std::string & level = "" )

static

Start a level in server mode.

Parameters

level The filename of the level to be started. If empty, the default level is started.

void orxonox::GSMainMenu::startStandalone ( const std::string & level = "" )

static

Start a level in standalone mode.

Parameters

level The filename of the level to be started. If empty, the default level is started.

void orxonox::GSMainMenu::update ( const Clock & time )

overridevirtual

Reimplemented from orxonox::GameState.

Member Data Documentation

AmbientSound* orxonox::GSMainMenu::ambient_

private

Ogre::Camera* orxonox::GSMainMenu::camera_

private

Scene* orxonox::GSMainMenu::scene_

private

std::string orxonox::GSMainMenu::soundPathMain_

private

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

orxonox/gamestates/GSMainMenu.h
orxonox/gamestates/GSMainMenu.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation