VoltAir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Signals | Public Member Functions | Properties | List of all members
LevelInfo Class Reference

Metadata for a Level. More...

Inheritance diagram for LevelInfo:
QObject

Signals

void nameChanged ()
 Emitted when name changes. More...
 
void fileNameChanged ()
 Emitted when fileName changes. More...
 
void tutorialChanged ()
 Emitted when tutorial changes. More...
 
void screenshotFileNameChanged ()
 Emitted when screenshotFileName changes. More...
 

Public Member Functions

 LevelInfo (QObject *parent=nullptr)
 Constructs a LevelInfo. More...
 
const QStringgetName () const
 Returns name. More...
 
void setName (const QString &value)
 Sets name. More...
 
const QStringgetFileName () const
 Returns fileName. More...
 
void setFileName (const QString &value)
 Sets fileName. More...
 
bool isTutorial () const
 Returns tutorial. More...
 
void setTutorial (bool value)
 Sets tutorial. More...
 
const QStringgetScreenshotFileName () const
 Returns screenshotFileName. More...
 
void setScreenshotFileName (const QString &value)
 Sets screenshotFileName. More...
 
EnvironmentgetEnvironment () const
 Returns environment. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
virtual const QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
 
const QObjectList & children () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
bool inherits (const char *className) const
 
void deleteLater ()
 

Properties

QString name
 Human-readable name of the Level. More...
 
QString fileName
 Name of QML level file to be used for loading the Level. More...
 
bool tutorial
 Whether or not the Level is a tutorial level. More...
 
QString screenshotFileName
 Name of image asset file for the Level screenshot / thumbnail. More...
 
Environment environment
 Environment to which this LevelInfo belongs, or null if defined out of the context of an Environment. More...
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 

Detailed Description

Metadata for a Level.

The information contained in LevelInfo can be used to load and display a Level.

Constructor & Destructor Documentation

LevelInfo::LevelInfo ( QObject parent = nullptr)
explicit

Constructs a LevelInfo.

Parameters
parentParent object

Member Function Documentation

void LevelInfo::fileNameChanged ( )
signal

Emitted when fileName changes.

Environment* LevelInfo::getEnvironment ( ) const

Returns environment.

const QString& LevelInfo::getFileName ( ) const
inline

Returns fileName.

const QString& LevelInfo::getName ( ) const
inline

Returns name.

const QString& LevelInfo::getScreenshotFileName ( ) const
inline
bool LevelInfo::isTutorial ( ) const
inline

Returns tutorial.

void LevelInfo::nameChanged ( )
signal

Emitted when name changes.

void LevelInfo::screenshotFileNameChanged ( )
signal

Emitted when screenshotFileName changes.

void LevelInfo::setFileName ( const QString value)

Sets fileName.

Parameters
valueString to set fileName to
void LevelInfo::setName ( const QString value)

Sets name.

Parameters
valueString to set name to
void LevelInfo::setScreenshotFileName ( const QString value)

Sets screenshotFileName.

Parameters
valueString to set screenshotFileName to
void LevelInfo::setTutorial ( bool  value)

Sets tutorial.

Parameters
valueBoolean to set tutorial to
void LevelInfo::tutorialChanged ( )
signal

Emitted when tutorial changes.

Property Documentation

Environment LevelInfo::environment
read

Environment to which this LevelInfo belongs, or null if defined out of the context of an Environment.

QString LevelInfo::fileName
readwrite

Name of QML level file to be used for loading the Level.

QString LevelInfo::name
readwrite

Human-readable name of the Level.

QString LevelInfo::screenshotFileName
readwrite

Name of image asset file for the Level screenshot / thumbnail.

bool LevelInfo::tutorial
readwrite

Whether or not the Level is a tutorial level.