#include <Dynacoe.h>

Description

Main class that handles automated updates of Dynacoe.

Static Functions
static int	Startup ()

static void	AddModule (Module *)

static int	Run ()

static Entity::ID &	Root ()

static void	AttachManager (Entity::ID)

static void	Quit ()

static void	Wait (int FPS)

static void	SetMaxFPS (int i)

static int	GetMaxFPS ()

static std::string	GetBaseDirectory ()

static std::string	Version ()

Member Function Documentation

static int Startup ( )

static

Initializes all Dynacoe assets.

Upon encountering an irrecoverable error, the statup function will return 0. Otherwise, it will return 1. No other functions should be used prior to calling this function.

static void AddModule ( Module * )

static

Installs a module to be updated during the execution loop.

A module is an updatable unit that is managed before and after the updating of entities. It is appropriate for behavior that should not interfere with the entity scope. FOr example, the Graphics interface is managed through a module.

This function adds a new module to the Engine. See Module.h

static int Run ( )

static

Begins the Engine execution loop.

Once run is initiated, all drawing to the screen and logic updating is automated. While running, it is also possible to utilize the debugging features such as the console and Entity debugger.

static Entity::ID& Root ( )

static

Returns the toplevel Entity.

From here, you can set the Entity that holds the toplevel of the project. By default there is none.

static void AttachManager ( Entity::ID )

static

Attaches a management-type entity.

static void Quit ( )

static

Ends the Engine execution loop.

static void Wait ( int FPS )

static

Sleeps until the time required for the target frames-per-second is reached.

Parameters

FPS	The target FPS; useful for loops.

The actual resolution is machine-dependent, but it tends to be millisecond resolution.

static void SetMaxFPS ( int i )

static

Sets the ideal frame per second that the main loop should clock at.

static int GetMaxFPS ( )

static

Gets the maximum FPS allowable by the Engine.

static std::string GetBaseDirectory ( )

static

Returns the starting directory of Dynacoe.

Reutrns an empty string if unavailable.

static std::string Version ( )

static

Returns the version of the Dynacoe library as a whole.

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

/home/jc/git/Dynacoe/DynacoeSrc/includes/Dynacoe/Dynacoe.h

Description

Static Functions

Member Function Documentation