GluonEngine::GameProject Class Reference
#include <gameproject.h>
Public Member Functions | |
| Q_INVOKABLE | GameProject (QObject *parent=0) |
| GameProject (const GameProject &other, QObject *parent=0) | |
| ~GameProject () | |
| bool | saveToFile () const |
| bool | loadFromFile () |
| bool | loadFromFile (QUrl filename) |
| QString | description () const |
| void | setDescription (QString newDescription) |
| QUrl | homepage () const |
| void | setHomepage (QUrl newHomepage) |
| QList< QUrl > | mediaInfo () const |
| void | setMediaInfo (QList< QUrl > newMediaInfo) |
| QUrl | filename () const |
| void | setFilename (QUrl newFilename) |
| Scene * | entryPoint () const |
| void | setEntryPoint (Scene *newEntryPoint) |
Properties | |
| QString | description |
| QUrl | homepage |
| QList< QUrl > | mediaInfo |
| QUrl | filename |
| GluonEngine::Scene | entryPoint |
Detailed Description
The GameProject class describes and contains a complete game project, and all the meta information that goes with it, making it into a complete game (minus engine, which is Gluon::Game and all the Gluon::Component subclasses). As such it is the top level of the GameObject hierarchy.
The project's children (all assets, gameobjects and prefabs in the project) are all found in the QObject hierarchy - they are simply anchored by the QObject parent/child system.
- Note:
- To find out which is the current scene in a game, use Game::currentScene
Definition at line 49 of file gameproject.h.
Constructor & Destructor Documentation
| GameProject::GameProject | ( | QObject * | parent = 0 |
) |
Definition at line 40 of file gameproject.cpp.
| GameProject::GameProject | ( | const GameProject & | other, | |
| QObject * | parent = 0 | |||
| ) |
Definition at line 47 of file gameproject.cpp.
| GameProject::~GameProject | ( | ) |
Definition at line 53 of file gameproject.cpp.
Member Function Documentation
| QString GluonEngine::GameProject::description | ( | ) | const |
| Scene* GluonEngine::GameProject::entryPoint | ( | ) | const |
| QUrl GluonEngine::GameProject::filename | ( | ) | const |
| QUrl GluonEngine::GameProject::homepage | ( | ) | const |
| bool GameProject::loadFromFile | ( | QUrl | filename | ) |
Definition at line 174 of file gameproject.cpp.
| bool GameProject::loadFromFile | ( | ) |
Definition at line 79 of file gameproject.cpp.
| QList<QUrl> GluonEngine::GameProject::mediaInfo | ( | ) | const |
| bool GameProject::saveToFile | ( | ) | const |
Definition at line 58 of file gameproject.cpp.
| void GameProject::setDescription | ( | QString | newDescription | ) |
Definition at line 191 of file gameproject.cpp.
| void GameProject::setEntryPoint | ( | Scene * | newEntryPoint | ) |
Definition at line 237 of file gameproject.cpp.
| void GameProject::setFilename | ( | QUrl | newFilename | ) |
Definition at line 225 of file gameproject.cpp.
| void GameProject::setHomepage | ( | QUrl | newHomepage | ) |
Definition at line 202 of file gameproject.cpp.
| void GameProject::setMediaInfo | ( | QList< QUrl > | newMediaInfo | ) |
Definition at line 213 of file gameproject.cpp.
Property Documentation
QString GameProject::description [read, write] |
A long description of the game. This can contain any string data, but you should attempt to use simplified HTML syntax for markup.
- Note:
- This should be extended when we have more knowledge about where this will be used (GamingFreedom.org and clients)
Definition at line 60 of file gameproject.h.
Scene * GameProject::entryPoint [read, write] |
The Scene in which the game should begin. This is likely going to be an intro scene or a menu but can also be directly into gameplay by pointing to a scene which contains the game.
Definition at line 84 of file gameproject.h.
QUrl GameProject::filename [read] |
The filename of the GameProject, meaning the name of the project file on disk, relative to the project directory.
Definition at line 77 of file gameproject.h.
QUrl GameProject::homepage [read, write] |
This will likely be the GamingFreedom.org page, but other pages might be needed as well, for commercial or other ventures who have their own websites: So, full URL to the homepage of the game.
Definition at line 66 of file gameproject.h.
QList< QUrl > GameProject::mediaInfo [read, write] |
A list of URLs for images, videos and other various interesting media (for screenshots, gameplay videos, promo trailers, documentation PDFs...)
Definition at line 71 of file gameproject.h.
The documentation for this class was generated from the following files:
- engine/gameproject.h
- engine/gameproject.cpp
