MuGameFramework  1.0
MuGameFramework is a 2D game framework built upon C# and SFML
 All Classes Namespaces Files Functions Variables Enumerations Properties
MuGameFramework.GameFramework Class Reference

Core code behind the running of the Game Framework More...

Public Member Functions

 GameFramework (GameCode gameCode)
 Initialize an instance of the MuGameFramework
void StartEngine ()
 Start the game engine
void CloseGame ()
 Close the window and end the game system
void Dispose ()
 Used to explicitly free all resources currently in use by this object before destruction

Protected Member Functions

virtual void Dispose (bool disposing)
 Dispose any and all objects, either managed or unmanaged at the end of this objects lifespan

Properties

Window Window [get, set]
 Window in which we will draw our game
GameTime GameTime [get, set]
 Object used to keep track of the gane time while the engine is running
ContentManager Content [get, set]
 Content Manager used to load and unload content from the game
GameComponentList Components [get, set]
 GameComponents List used to manage GameComponents
GameServices Services [get, set]
 Global access to a collection of services via GameServices

Detailed Description

Core code behind the running of the Game Framework

Constructor & Destructor Documentation

MuGameFramework.GameFramework.GameFramework ( GameCode  gameCode)

Initialize an instance of the MuGameFramework

Parameters
gameCodeSource file for the games GameCode

Member Function Documentation

void MuGameFramework.GameFramework.CloseGame ( )

Close the window and end the game system

virtual void MuGameFramework.GameFramework.Dispose ( bool  disposing)
protectedvirtual

Dispose any and all objects, either managed or unmanaged at the end of this objects lifespan

Parameters
disposingDispose of Managed objects?
void MuGameFramework.GameFramework.Dispose ( )

Used to explicitly free all resources currently in use by this object before destruction

void MuGameFramework.GameFramework.StartEngine ( )

Start the game engine

Property Documentation

GameComponentList MuGameFramework.GameFramework.Components
getset

GameComponents List used to manage GameComponents

ContentManager MuGameFramework.GameFramework.Content
getset

Content Manager used to load and unload content from the game

GameTime MuGameFramework.GameFramework.GameTime
getset

Object used to keep track of the gane time while the engine is running

GameServices MuGameFramework.GameFramework.Services
getset

Global access to a collection of services via GameServices

Window MuGameFramework.GameFramework.Window
getset

Window in which we will draw our game


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