Class UniverseBase<TCoordinates>

Namespace

AlphaFramework.World

Assembly

AlphaFramework.World.dll

A common base for game worlds (but not a running game). Equivalent to the content of a map file.

public abstract class UniverseBase<TCoordinates> : IUniverse where TCoordinates : struct

Type Parameters

TCoordinates

Data type for storing position coordinates of objects in the game world.

Inheritance

object

UniverseBase<TCoordinates>

Implements

IUniverse

Derived

Universe

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Properties

CurrentCamera

The current position and direction of the camera in the game.

[Browsable(false)]
public CameraState<TCoordinates>? CurrentCamera { get; set; }

Property Value

CameraState<TCoordinates>

Remarks

This is updated only when leaving the game, not continuously.

GameTime

Total elapsed game time in seconds.

public double GameTime { get; set; }

Property Value

double

Pathfinder

The pathfinding engine used to navigate Positionables.

[Browsable(false)]
public IPathfinder<TCoordinates>? Pathfinder { get; set; }

Property Value

IPathfinder<TCoordinates>

Positionables

A collection of all Positionable<TCoordinates>s in this UniverseBase<TCoordinates>.

[Browsable(false)]
public abstract MonitoredCollection<Positionable<TCoordinates>> Positionables { get; }

Property Value

MonitoredCollection<Positionable<TCoordinates>>

Skybox

The name of the skybox to use for this map; may be null or empty.

public string? Skybox { get; set; }

Property Value

string

SourceFile

The map file this world was loaded from.

[Browsable(false)]
public string SourceFile { get; set; }

Property Value

string

Remarks

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

Methods

Save()

Overwrites the map file this UniverseBase<TCoordinates> was loaded from with the changed data.

public void Save()

Exceptions

IOException

A problem occurred while writing the file.

UnauthorizedAccessException

Write access to the file is not permitted.

Save(string)

Saves this UniverseBase<TCoordinates> in a compressed XML file (map file).

public abstract void Save(string path)

Parameters

path string

The file to save in.

Exceptions

IOException

A problem occurred while writing the file.

UnauthorizedAccessException

Write access to the file is not permitted.

Update(IUpdateable, double)

Updates a single IUpdateable.

protected virtual void Update(IUpdateable updateable, double elapsedGameTime)

Parameters

updateable IUpdateable

elapsedGameTime double

Update(double)

Updates the UniverseBase<TCoordinates> and all Positionable<TCoordinates>s in it.

public virtual void Update(double elapsedGameTime)

Parameters

elapsedGameTime double

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

Events

SkyboxChanged

Occurs when Skybox was changed.

public event Action? SkyboxChanged

Event Type

Action