Interface IShellContext

Interface for the in-game user interface shell.

Namespace: SociallyDistant.Core.Shell

Assembly: SociallyDistant.Framework.dll

Syntax

public interface IShellContext

Properties

InfoPanelService

Gets a reference to the Info Panel Service, which manages the state of the desktop's information panel widgets.

Declaration

IInfoPanelService InfoPanelService { get; }

Property Value

Type	Description
IInfoPanelService

NotificationManager

Gets the game's Notification Manager.

Declaration

INotificationManager NotificationManager { get; }

Property Value

Type	Description
INotificationManager

Methods

CreateMessageDialog(string)

Create an alert dialog.

Declaration

IMessageDialog CreateMessageDialog(string title)

Parameters

Type	Name	Description
string	title	The title of the alert.

Returns

Type	Description
IMessageDialog	An implementation of IMessageDialog representing the alert.

CreateOverlay()

Create a fullscreen overlay.

Declaration

IShellOverlay CreateOverlay()

Returns

Type	Description
IShellOverlay	An IShellOverlay implementation representing the fullscreen overlay.

CreateTutorialOverlay(LayoutRect)

Create a tutorial overlay.

Declaration

ITutorialOverlay CreateTutorialOverlay(LayoutRect focusArea)

Parameters

Type	Name	Description
LayoutRect	focusArea	The area on the screen, in GUI units, to highlight.

Returns

Type	Description
ITutorialOverlay	An ITutorialOverlay implementation representing the overlay.

OpenFile(ISystemProcess, string)

Open a file using the associated program for the file type.

Declaration

bool OpenFile(ISystemProcess context, string filePath)

Parameters

Type	Name	Description
ISystemProcess	context	An instance of ISystemProcess providing context for the device the file is being opened on.
string	filePath	The absolute path to the file.

Returns

Type	Description
bool	True if the file was opened, false otherwise.

Remarks

If the given path is that of a directory, the File Manager will be opened to that directory's contents.

File associations are based on MIME type, which is determined by the file extension in the file's name. If the game can't find a program compatible with the determined MIME type, then the game will fall back to the Hex Viewer and the user will get a hexdump of the file's contents.

Note that the player must have unlocked/installed the program used to open the file. If that's not the case, it will be treated as an unknown MIME type and a hex dump will be shown. This is because, when opening files on a hacked device, the contents are downloaded locally to the player's home directory.

OpenProgram(IProgram, string[])

Open a program window on the current device.

Declaration

bool OpenProgram(IProgram program, string[] arguments)

Parameters

Type	Name	Description
IProgram	program	The program to open.
string[]	arguments	Command-line arguments to be passed to the program.

Returns

Type	Description
bool	True if the program was opened.

OpenProgram(IProgram, string[], ISystemProcess, IConsoleDriver)

Open a program window.

Declaration

bool OpenProgram(IProgram programToOpen, string[] arguments, ISystemProcess programProcess, IConsoleDriver console)

Parameters

Type	Name	Description
IProgram	programToOpen	The program to open.
string[]	arguments	Command-line arguments that should be passed to the program.
ISystemProcess	programProcess	An in-game process binding the program to a user and device.
IConsoleDriver	console	A console driver for the program to write console output to, if it wants to.

Returns

Type	Description
bool	True if the window was opened.

OpenSettings()

Open the System Settings screen.

Declaration

void OpenSettings()

ShowExceptionMessage(Exception)

Show an exception handling alert.

Declaration

Task ShowExceptionMessage(Exception ex)

Parameters

Type	Name	Description
Exception	ex	The exception to alert about.

Returns

Type	Description
Task	A task that resolves when the alert is dismissed.

ShowInfoDialog(string, string)

Show an alert message and wait for it to be dismissed.

Declaration

Task ShowInfoDialog(string title, string message)

Parameters

Type	Name	Description
string	title	The title of the alert.
string	message	The message to be shown in the alert.

Returns

Type	Description
Task	A task that is resolved when the alert is dismissed.