Interface IGameContext

Represents the core of Socially Distant.

Namespace: SociallyDistant.Core.Modules
Assembly: SociallyDistant.Framework.dll
Syntax
public interface IGameContext

Properties

ContentManager

Gets an instance of the ContentManager.

Declaration
IContentManager ContentManager { get; }
Property Value
Type Description
IContentManager

CurrentGameMode

Declaration
GameMode CurrentGameMode { get; }
Property Value
Type Description
GameMode

CurrentSaveDataDirectory

Gets the path on the filesystem to where the current save's data is stored. Will return null if no save data is loaded or if the current save isn't local and persistent (i.e, if we are a client on a network game or if the current game is in-memory.)

Declaration
string? CurrentSaveDataDirectory { get; }
Property Value
Type Description
string

DeviceManager

Declaration
ITaskManager DeviceManager { get; }
Property Value
Type Description
ITaskManager

GameInstance

Declaration
Game GameInstance { get; }
Property Value
Type Description
Game

GameModeObservable

Declaration
IObservable<GameMode> GameModeObservable { get; }
Property Value
Type Description
IObservable<GameMode>

IsDebugWorld

Declaration
bool IsDebugWorld { get; }
Property Value
Type Description
bool

Kernel

Gets a reference to the player kernel.

Declaration
IKernel Kernel { get; }
Property Value
Type Description
IKernel

ModuleManager

Declaration
IModuleManager ModuleManager { get; }
Property Value
Type Description
IModuleManager

Network

Declaration
INetworkSimulation Network { get; }
Property Value
Type Description
INetworkSimulation

ScriptSystem

Gets a reference to the script system.

Declaration
IScriptSystem ScriptSystem { get; }
Property Value
Type Description
IScriptSystem

SettingsManager

Gets a reference to the game's settings manager.

Declaration
ISettingsManager SettingsManager { get; }
Property Value
Type Description
ISettingsManager

Shell

Gets a reference to the game's UI manager.

Declaration
IShellContext Shell { get; }
Property Value
Type Description
IShellContext

SocialService

Declaration
ISocialService SocialService { get; }
Property Value
Type Description
ISocialService

UriManager

Declaration
IUriManager UriManager { get; }
Property Value
Type Description
IUriManager

VirtualScreen

Declaration
IVirtualScreen? VirtualScreen { get; }
Property Value
Type Description
IVirtualScreen

WorldManager

Gets a reference to the world manager, which manages the state of the game's world.

Declaration
IWorldManager WorldManager { get; }
Property Value
Type Description
IWorldManager

Methods

CreateRestorePoint(string)

Saves the game and creates a new restore point based on it.

Declaration
Task<IGameRestorePoint?> CreateRestorePoint(string id)
Parameters
Type Name Description
string id

An arbitrary ID to assign to the restore point, for your own book-keeping.
Returns
Type Description
Task<IGameRestorePoint>

EndCurrentGame(bool)

Declaration
Task EndCurrentGame(bool save)
Parameters
Type Name Description
bool save
Returns
Type Description
Task

GoToLoginScreen()

Declaration
Task GoToLoginScreen()
Returns
Type Description
Task

SaveCurrentGame(bool)

Declaration
Task SaveCurrentGame(bool silent)
Parameters
Type Name Description
bool silent
Returns
Type Description
Task

SetPlayerHostname(string)

Declaration
void SetPlayerHostname(string hostname)
Parameters
Type Name Description
string hostname

StartCharacterCreator()

Declaration
Task StartCharacterCreator()
Returns
Type Description
Task

StartGame(IGameData)

Declaration
Task StartGame(IGameData gameData)
Parameters
Type Name Description
IGameData gameData
Returns
Type Description
Task

Extension Methods