AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
AlphaFramework.World.IUniverse Interface Reference

A common base for all UniverseBase{TCoordinates} types. More...

Inheritance diagram for AlphaFramework.World.IUniverse:
AlphaFramework.World.UniverseBase< TCoordinates >

Public Member Functions

void Update (double elapsedGameTime)
 Updates the UniverseBase{TCoordinates} and all Positionable{TCoordinates}s in it. More...
 
void Save (string path)
 Saves this UniverseBase{TCoordinates} in a compressed XML file (map file). More...
 
void Save ()
 Overwrites the map file this UniverseBase{TCoordinates} was loaded from with the changed data. More...
 

Properties

string SourceFile [get, set]
 The map file this world was loaded from. More...
 

Detailed Description

A common base for all UniverseBase{TCoordinates} types.

Member Function Documentation

void AlphaFramework.World.IUniverse.Save ( string  path)

Saves this UniverseBase{TCoordinates} in a compressed XML file (map file).

Parameters
pathThe file to save in.
Exceptions
IOExceptionA problem occurred while writing the file.
UnauthorizedAccessExceptionWrite access to the file is not permitted.

Implemented in AlphaFramework.World.UniverseBase< TCoordinates >.

void AlphaFramework.World.IUniverse.Save ( )

Overwrites the map file this UniverseBase{TCoordinates} was loaded from with the changed data.

Exceptions
IOExceptionA problem occurred while writing the file.
UnauthorizedAccessExceptionWrite access to the file is not permitted.

Implemented in AlphaFramework.World.UniverseBase< TCoordinates >.

void AlphaFramework.World.IUniverse.Update ( double  elapsedGameTime)

Updates the UniverseBase{TCoordinates} and all Positionable{TCoordinates}s in it.

Parameters
elapsedGameTimeHow much game time in seconds has elapsed since this method was last called.

Implemented in AlphaFramework.World.UniverseBase< TCoordinates >.

Property Documentation

string AlphaFramework.World.IUniverse.SourceFile
getset

The map file this world was loaded from.

Is not serialized/stored, is set by whatever method loads the universe.


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