Rubeus::REngine class

A class the contains all components that make up Rubeus.

Contents

Base classes

class RMasterComponent
A master component. Serves as parent class for all components.

Constructors, destructors, conversion operators

REngine()
The engine constructor.
~REngine()
The engine destructor.

Public functions

void load(RLevel& level)
Load a level into memory and run it.
void run()
Run the main game loop.
void killAliveLevel()
Kill all current level associated objects.
void end()
End the current Rubeus game session.
auto getResourceLoader() const -> UtilityComponents::RLoaderComponent*
Get the resource loader.
auto getCurrentLevel() const -> RLevel*
Get the current level.
auto getCurrentWindow() const -> GraphicComponents::RWindowComponent*
Get the window of current level.
auto getCurrentLevelAudioManager() const -> AudioComponents::RSymphony*
Get the audio manager of the current level.
auto getCurrentLevelInputManager() const -> RInputManager*
Get the input manager of the current level.
auto getWorld() const -> RWorld*
Get the world of the current level.
void load_level(var data)
Loads the specified level name.
void engine_ok(var data = NULL)
Checks if engine is ready for use.

Public variables

std::string m_StartupLevelName
The startup level of the entire game. Rubeus ends if this is found to be "" at the end of the frame.

Function documentation

Rubeus::REngine::REngine()

The engine constructor.

Rubeus::REngine::~REngine()

The engine destructor.

void Rubeus::REngine::load(RLevel& level)

Load a level into memory and run it.

Parameters
level The level object to be loaded in.

UtilityComponents::RLoaderComponent* Rubeus::REngine::getResourceLoader() const

Get the resource loader.

Returns Pointer to the resource loader.

RLevel* Rubeus::REngine::getCurrentLevel() const

Get the current level.

Returns Pointer to the current level.

GraphicComponents::RWindowComponent* Rubeus::REngine::getCurrentWindow() const

Get the window of current level.

Returns Pointer to the window object.

AudioComponents::RSymphony* Rubeus::REngine::getCurrentLevelAudioManager() const

Get the audio manager of the current level.

Returns Pointer to the current level audio manager.

RInputManager* Rubeus::REngine::getCurrentLevelInputManager() const

Get the input manager of the current level.

Returns Pointer to the input manager object.

RWorld* Rubeus::REngine::getWorld() const

Get the world of the current level.

Returns Pointer to the world object.

void Rubeus::REngine::load_level(var data)

Loads the specified level name.

Parameters
data Level name

void Rubeus::REngine::engine_ok(var data = NULL)

Checks if engine is ready for use.

Parameters
data NULL