Class ScriptingProvider

Allows you to implement and register your own scripting provider.

Note: You can't implement this, implement ScriptingProvider<TGlobalScript, TProfileScript> instead.

Inheritance
object
CorePropertyChanged
PluginFeature
ScriptingProvider
ScriptingProvider<TGlobalScript, TProfileScript>
Implements
Inherited Members
Namespace: Artemis.Core.ScriptingProviders
Assembly: Artemis.Core.dll
Syntax
public abstract class ScriptingProvider : PluginFeature, IDisposable

Constructors

ScriptingProvider()

The base constructor of the ScriptingProvider class

Declaration
protected ScriptingProvider()

Properties

LanguageName

Gets the name of the scripting language this provider provides

Declaration
public abstract string LanguageName { get; }
Property Value
Type Description
string

Scripts

Gets a list of all active scripts belonging to this scripting provider

Declaration
public ReadOnlyCollection<Script> Scripts { get; }
Property Value
Type Description
ReadOnlyCollection<Script>

Methods

CreateScriptEditor(ScriptType)

Called when the UI needs a script editor for the specified scriptType

Declaration
public abstract IScriptEditorViewModel CreateScriptEditor(ScriptType scriptType)
Parameters
Type Name Description
ScriptType scriptType

The type of script the editor will host
Returns
Type Description
IScriptEditorViewModel

GetDefaultScriptContent(ScriptType)

Called when a script for a certain type needs default content.

Declaration
public abstract string GetDefaultScriptContent(ScriptType scriptType)
Parameters
Type Name Description
ScriptType scriptType

The type of script the default content is for.
Returns
Type Description
string

Implements

IDisposable