Class UserScriptExecutionContext

Inheritance
object
UserScriptExecutionContext
Implements
Inherited Members
Namespace: SociallyDistant.Core.Core.Scripting
Assembly: SociallyDistant.Framework.dll
Syntax
public sealed class UserScriptExecutionContext : IScriptExecutionContext

Constructors

UserScriptExecutionContext()

Declaration
public UserScriptExecutionContext()

Properties

FileSystem

Gets a reference to the shell's file system. If null, glob patterns won't be expanded.

Declaration
public IVirtualFileSystem? FileSystem { get; set; }
Property Value
Type Description
IVirtualFileSystem

Home

Gets a path to the user's home directory. If null, there is no home directory and '~' characters will not be expanded to it.

Declaration
public string? Home { get; set; }
Property Value
Type Description
string

ModuleManager

Declaration
public ScriptModuleManager ModuleManager { get; }
Property Value
Type Description
ScriptModuleManager

Title

Declaration
public string Title { get; set; }
Property Value
Type Description
string

WorkingDirectory

Gets a path to the current working directory. If none is specified, "/" will be used instead.

Declaration
public string? WorkingDirectory { get; set; }
Property Value
Type Description
string

Methods

DeclareFunction(string, IScriptFunction)

Declaration
public void DeclareFunction(string name, IScriptFunction body)
Parameters
Type Name Description
string name
IScriptFunction body

GetVariableValue(string)

Declaration
public string GetVariableValue(string variableName)
Parameters
Type Name Description
string variableName
Returns
Type Description
string

HandleCommandNotFound(string, string[], IConsoleDriver)

Declaration
public void HandleCommandNotFound(string name, string[] args, IConsoleDriver console)
Parameters
Type Name Description
string name
string[] args
IConsoleDriver console

OpenFileConsole(IConsoleDriver, string, FileRedirectionType)

Declaration
public IConsoleDriver OpenFileConsole(IConsoleDriver realConsole, string filePath, FileRedirectionType mode)
Parameters
Type Name Description
IConsoleDriver realConsole
string filePath
FileRedirectionType mode
Returns
Type Description
IConsoleDriver

SetVariableValue(string, string)

Declaration
public void SetVariableValue(string variableName, string value)
Parameters
Type Name Description
string variableName
string value

TryExecuteCommandAsync(string, string[], IConsoleDriver, IScriptExecutionContext?)

Declaration
public Task<int?> TryExecuteCommandAsync(string name, string[] args, IConsoleDriver console, IScriptExecutionContext? callSite = null)
Parameters
Type Name Description
string name
string[] args
IConsoleDriver console
IScriptExecutionContext callSite
Returns
Type Description
Task<int?>

Events

OnCommandNotFound

Declaration
public event Action<string, IConsoleDriver>? OnCommandNotFound
Event Type
Type Description
Action<string, IConsoleDriver>

Implements