Class Session

Namespace

FrameOfReference.World

Assembly

FrameOfReference.World.dll

Represents a game session (i.e. a game actually being played). It is equivalent to the content of a savegame.

public sealed class Session : SessionBase<Universe>

Inheritance

object

SessionBase<Universe>

Session

Inherited Members

SessionBase<Universe>.Universe

SessionBase<Universe>.MapSourceFile

SessionBase<Universe>.TimeWarpFactor

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

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?)

Constructors

Session()

Base-constructor for XML serialization. Do not call manually!

public Session()

Session(Universe)

Creates a new game session based upon a given Universe.

public Session(Universe baseUniverse)

Parameters

baseUniverse Universe

The universe to base the new game session on.

Fields

FileExt

The file extensions when this class is stored as a file.

public const string FileExt = ".FrameOfReferenceSave"

Field Value

string

Properties

LeftoverGameTime

GameTime time left over from the last Update(double) call due to the fixed update step size.

public double LeftoverGameTime { get; set; }

Property Value

double

Lua

The scripting engine used to execute story scripts.

public Lua? Lua { get; set; }

Property Value

Lua

TimeTravelInProgress

Indicates whwther a TimeTravel(double) request is currently being processed.

[Browsable(false)]
public bool TimeTravelInProgress { get; set; }

Property Value

bool

Methods

Load(string)

Loads a Session from an encrypted XML file (savegame).

public static Session Load(string path)

Parameters

path string

The file to load from.

Returns

Session

The loaded Session.

Exceptions

IOException

A problem occurred while reading the file.

UnauthorizedAccessException

Read access to the file is not permitted.

InvalidOperationException

A problem occurred while deserializing the XML data.

Save(string)

Saves this Session in an encrypted XML file (savegame).

public 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.

TimeTravel(double)

Like UpdateTo(double), but interpolates between the current and the target time smoothly.

public void TimeTravel(double gameTime)

Parameters

gameTime double

The target value for GameTime.

Update(double)

Updates the underlying Universe.

public override double Update(double elapsedRealTime)

Parameters

elapsedRealTime double

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

Returns

double

The elapsed game time (real time multiplied by TimeWarpFactor)

UpdateTo(double)

Updates the world to a specific point in game time.

public void UpdateTo(double gameTime)

Parameters

gameTime double

The target value for GameTime.