Interface IScriptingService

A service that allows you to manage various types of NodeScript instances

Namespace: Artemis.Core.Services

Assembly: Artemis.Core.dll

Syntax

public interface IScriptingService

Properties

GlobalScripts

Gets a list of all currently active global scripts

Declaration

ReadOnlyCollection<GlobalScript> GlobalScripts { get; }

Property Value

Type	Description
ReadOnlyCollection<GlobalScript>

ScriptingProviders

Gets a list of all available scripting providers

Declaration

ReadOnlyCollection<ScriptingProvider> ScriptingProviders { get; }

Property Value

Type	Description
ReadOnlyCollection<ScriptingProvider>

Methods

AddScript(ScriptConfiguration)

Adds a script by the provided script configuration to the global collection and instantiates it.

Declaration

GlobalScript AddScript(ScriptConfiguration scriptConfiguration)

Parameters

Type	Name	Description
ScriptConfiguration	scriptConfiguration	The script configuration whose script to add.

Returns

Type	Description
GlobalScript

AddScript(ScriptConfiguration, Profile)

Adds a script by the provided script configuration to the provided profile and instantiates it.

Declaration

ProfileScript AddScript(ScriptConfiguration scriptConfiguration, Profile profile)

Parameters

Type	Name	Description
ScriptConfiguration	scriptConfiguration	The script configuration whose script to add.
Profile	profile	The profile to add the script to.

Returns

Type	Description
ProfileScript

RemoveScript(ScriptConfiguration)

Removes a script by the provided script configuration from the global collection and disposes it.

Declaration

void RemoveScript(ScriptConfiguration scriptConfiguration)

Parameters

Type	Name	Description
ScriptConfiguration	scriptConfiguration	The script configuration whose script to remove.

RemoveScript(ScriptConfiguration, Profile)

Removes a script by the provided script configuration from the provided profile and disposes it.

Declaration

void RemoveScript(ScriptConfiguration scriptConfiguration, Profile profile)

Parameters

Type	Name	Description
ScriptConfiguration	scriptConfiguration	The script configuration whose script to remove.
Profile	profile	The profile to remove the script from.