Imaginary Game Engine API documentation
Engine Class
NamespacesIGEEngine

[This is preliminary documentation and is subject to change.]

Engine class, main entry point for IGE, brings all drivers together
Declaration Syntax
C#Visual BasicVisual C++
public class Engine
Public Class Engine
public ref class Engine
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
Engine()()()
Constructor

AddResourceDirectory(String)
Add a directory where resources should be located

AddResourceDirectory(String, String)
Add a directory where resources should be located

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FileReaders
Get a dictionary of file extensions and their ReadFile based handlers

Files
Get the collection of files and their location

Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
GraphicsDriver
Get the current graphics driver

GraphicsDriverLoaded
Event that gets fired when a graphics driver is activated and initialised

LoadScript(String)
Load a .NET script file

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OpenFile<(Of <(T>)>)(String)
Open a file or pull it from the cache

OpenFile<(Of <(T>)>)(String, Type)
Open a file with a specific loader or pull it from the cache

PhysicsDriver
Get the current physics driver

Run(Scene)
Start update and rendering loops

SetGraphicsDriver(GraphicsDriverPlugin, Int32, WindowEnvironment, Object)
Activate a graphics driver

SetPhysicsDriver(PhysicsPlugin)
Activate a physics driver

SetSoundDriver(SoundDriverPlugin, String)
Activate a sound driver

SignalEvent(String, array<Object>[]()[])
Fire an engine event

SoundDriver
Get the current sound driver

Stop(UpdateEventHandler)
Stop the update and rendering loops (delayed execution!)

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
UpdateScene
Event that gets fired when the engine is updating the scene

Inheritance Hierarchy
Object
Engine

Assembly: IGE Core (Module: IGE Core) Version: 0.1.2957.39562 (0.1.0.0)