The LevelInfo class can be used to store information regarding a Level in its level file. More...

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

Inheritance diagram for orxonox::LevelInfo:

Public Member Functions
	LevelInfo (Context *context)

virtual	~LevelInfo ()
	Destructor. More...

LevelInfoItem *	copy (void)
	Copies the contents of this LevelInfo object to a new LevelInfoItem object. More...

const std::string &	getDescription () const
	Get the description of the Level. More...

const std::string &	getScreenshot () const
	Get the screenshot of the Level. More...

const std::string &	getStartingShips (void) const
	Get the starting ship models of the level. More...

const std::string &	getTags (void) const
	Get the lis of the tags the Level is tagged with. More...

void	setDescription (const std::string &description)
	Set the description of the Level. More...

void	setScreenshot (const std::string &screenshot)
	Set the screenshot of the Level. More...

void	setStartingShips (const std::string &ships)
	Set the starting ship models of the level. More...

void	setTags (const std::string &tags)
	Set the tags the Level is tagged with. More...

virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode) override
	Creates a LevelInfo object through XML. More...

Public Member Functions inherited from orxonox::BaseObject
	BaseObject (Context *context)
	Constructor: Registers the object in the BaseObject-list. More...

virtual	~BaseObject ()
	Destructor. More...

void	addEventListener (BaseObject *listener)
	Adds an object which listens to the events of this object. More...

void	addEventSource (BaseObject *source, const std::string &state)
	Adds a new event source for a specific state. More...

void	addTemplate (const std::string &name)
	Adds a Template to the object. More...

void	addTemplate (Template *temp)
	Adds a Template to the object. More...

virtual void	changedActivity ()
	This function gets called if the activity of the object changes. More...

virtual void	changedMainStateName ()
	This function gets called if the main state name of the object changes. More...

virtual void	changedName ()
	This function gets called if the name of the object changes. More...

virtual void	changedVisibility ()
	This function gets called if the visibility of the object changes. More...

void	fireEvent (const std::string &name="")
	Fires an event (without a state). More...

void	fireEvent (bool activate, const std::string &name="")
	Fires an event which activates or deactivates a state. More...

void	fireEvent (bool activate, BaseObject *originator, const std::string &name="")
	Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...

void	fireEvent (Event &event)
	Fires an event, using the Event struct. More...

BaseObject *	getCreator () const

BaseObject *	getEventListener (unsigned int index) const
	Returns an event listener with a given index. More...

BaseObject *	getEventSource (unsigned int index, const std::string &state) const
	Returns an eventsource with a given index. More...

const XMLFile *	getFile () const
	Returns a pointer to the XMLFile that loaded this object. More...

const std::string &	getFilename () const
	Returns the levelfile that loaded this object. More...

Gametype *	getGametype () const

Level *	getLevel () const

const std::string &	getLoaderIndentation () const
	Returns the indentation of the debug output in the Loader. More...

const std::string &	getMainStateName () const
	Returns the name of the main state. More...

const std::string &	getName () const
	Returns the name of the object. More...

Namespace *	getNamespace () const

const std::string &	getOldName () const
	Returns the old name of the object. More...

Scene *	getScene () const

virtual uint32_t	getSceneID () const

const std::set< Template * > &	getTemplates () const
	Returns the set of all aplied templates. More...

const mbool &	isActive () const
	Returns the state of the objects activity. More...

bool	isInitialized () const
	Returns if the object was initialized (passed the object registration). More...

const mbool &	isVisible () const
	Returns the state of the objects visibility. More...

virtual void	processEvent (Event &event)
	Processing an event by calling the right main state. More...

void	removeEventSource (BaseObject *source)
	Removes an eventsource (but doesn't unregister itself at the source). More...

void	setActive (bool bActive)
	Sets the state of the objects activity. More...

void	setCreator (BaseObject *creator)

void	setFile (const XMLFile *file)
	Sets a pointer to the xml file that loaded this object. More...

void	setGametype (const StrongOrWeakPtr< Gametype > &gametype)

void	setLevel (const StrongOrWeakPtr< Level > &level)

void	setLoaderIndentation (const std::string &indentation)
	Sets the indentation of the debug output in the Loader. More...

void	setMainState (bool state)
	Sets the main state of the object to a given boolean value. More...

void	setMainStateName (const std::string &name)
	Sets the name of the main state (used for event reactions). More...

void	setName (const std::string &name)
	Sets the name of the object. More...

void	setNamespace (const StrongOrWeakPtr< Namespace > &ns)

void	setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)

void	setVisible (bool bVisible)
	Sets the state of the objects visibility. More...

virtual void	XMLEventPort (Element &xmlelement, XMLPort::Mode mode)
	Defines the possible event states of this object and parses eventsources from an XML file. More...

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

OrxonoxClass &	operator= (const OrxonoxClass &)=default

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...

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

virtual	~Destroyable ()
	Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...

void	destroy ()
	Deletes the object if no strong pointers point to this object. More...

void	destroyLater ()
	Works like destroy() but doesn't destroy the object until the current tick has ended. More...

unsigned int	getReferenceCount () const
	Returns the number of strong pointers that point to this object. More...

Public Member Functions inherited from orxonox::LevelInfoItem
	LevelInfoItem ()
	Default constructor. More...

	LevelInfoItem (const std::string &name, const std::string filename)
	Constructor. Initializes the object. More...

virtual	~LevelInfoItem ()
	Destructor. More...

bool	addStartingShip (const std::string &ship, bool update=true)
	Add a model to shipselection. More...

bool	addTag (const std::string &tag, bool update=true)
	Add a tag to the set of tags the Level is tagged with. More...

const std::string &	getDescription () const
	Get the description of the Level. More...

const std::string &	getName (void) const
	Get the name of the Level. More...

const std::string &	getScreenshot () const
	Get the screenshot of the Level. More...

const std::string &	getStartingShips (void) const
	Get the set of starting ship models the Level allows. More...

const std::string &	getTags (void) const
	Get the lis of the tags the Level is tagged with. More...

const std::string &	getXMLFilename (void) const
	Get the XML-filename of the Level. More...

bool	hasStartingShip (const std::string &ship) const
	Get whether the Level allows a specific starting ship model. More...

bool	hasTag (const std::string &tag) const
	Get whether the Level has a specific tag. More...

void	selectStartingShip (const std::string &ship)

void	setDescription (const std::string &description)
	Set the description of the Level. More...

void	setName (const std::string &name)
	Set the name of the Level. More...

void	setScreenshot (const std::string &screenshot)
	Set the screenshot of the Level. More...

void	setStartingShips (const std::string &ships)
	Set the starting ship models of the level. More...

void	setTags (const std::string &tags)
	Set the tags the Level is tagged with. More...

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

Additional Inherited Members
Static Public Member Functions inherited from orxonox::BaseObject
static void	loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject object, Identifier identifier)
	Manually loads all event states, even if the class doesn't officially support them. More...

Protected Member Functions inherited from orxonox::BaseObject
void	addEventState (const std::string &name, EventState *container)
	Adds a new event-state to the object. More...

EventState *	getEventState (const std::string &name) const
	Returns the event-state with the given name. More...

Protected Member Functions inherited from orxonox::Destroyable
virtual void	preDestroy ()
	This virtual function is called if destroy() is called and no StrongPtr points to this object. More...

Protected Member Functions inherited from orxonox::LevelInfoItem
void	setXMLFilename (const std::string &filename)
	Set the XML-filename of the Level. More...

Protected Attributes inherited from orxonox::BaseObject
mbool	bActive_
	True = the object is active. More...

mbool	bVisible_
	True = the object is visible. More...

FunctorPtr	mainStateFunctor_

std::string	mainStateName_

std::string	name_
	The name of the object. More...

std::set< std::string >	networkTemplateNames_

std::string	oldName_
	The old name of the object. More...

Protected Attributes inherited from orxonox::LevelInfoItem
std::string	xmlfilename_
	The XML-filename of the Level. More...

Detailed Description

The LevelInfo class can be used to store information regarding a Level in its level file.

The following parameters can be specified:

name The name of the level.
description The description of the level.
screenshot The screenshot of the level.
tags A comma-seperated string of tags. Allowed tags are: test, singleplayer, multiplayer, showcase, tutorial, presentation, shipselection.
(optional) startingships The comma-seperated string of starting ship models An example would be:
<LevelInfo
name = "Levelname"lhs->compare(rhs) < 0
description = "This is just some awesome level."
screenshot = "Screenshot.png"
tags = "test, awesome"
/>
The LevelInfo is best located at the top of the level file.

Author: Damian 'Mozork' Frick Matthias Hutter

Constructor & Destructor Documentation

orxonox::LevelInfo::LevelInfo ( Context * context )

orxonox::LevelInfo::~LevelInfo ( )

virtual

Destructor.

Member Function Documentation

LevelInfoItem * orxonox::LevelInfo::copy ( void )

Copies the contents of this LevelInfo object to a new LevelInfoItem object.

This is needed, because a LeveInfo object is only created within the scope of the XML-file it is loaded with and is destroyed once that is unloaded.

Returns: Returns a new LevelInfoItem with the same contents as the LevelInfo object.

const std::string& orxonox::LevelInfo::getDescription ( void ) const

inline

Get the description of the Level.

Returns: Returns the description of the Level.

const std::string& orxonox::LevelInfo::getScreenshot ( ) const

inline

Get the screenshot of the Level.

Returns: Returns the screenshot of the Level.

const std::string& orxonox::LevelInfo::getStartingShips ( void ) const

inline

Get the starting ship models of the level.

Returns: Returns a comma-seperated string of all the allowed ship models for the shipselection.

const std::string& orxonox::LevelInfo::getTags ( void ) const

inline

Get the lis of the tags the Level is tagged with.

Returns: Returns a comma-seperated string of all the tags the Level is tagged with.

void orxonox::LevelInfo::setDescription ( const std::string & description )

inline

Set the description of the Level.

Parameters

description The description to be set.

void orxonox::LevelInfo::setScreenshot ( const std::string & screenshot )

inline

Set the screenshot of the Level.

Parameters

screenshot The screenshot to be set.

void orxonox::LevelInfo::setStartingShips ( const std::string & ships )

inline

Set the starting ship models of the level.

Parameters

ships A comma-seperated string of all the allowed ship models for the shipselection.

void orxonox::LevelInfo::setTags ( const std::string & tags )

inline

Set the tags the Level is tagged with.

Parameters

tags	A comma-seperated string of all the tags to be set.

void orxonox::LevelInfo::XMLPort	(	Element &	xmlelement,
		XMLPort::Mode	mode
	)

overridevirtual

Creates a LevelInfo object through XML.

Reimplemented from orxonox::BaseObject.

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

orxonox/LevelInfo.h
orxonox/LevelInfo.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation