Class Script

Namespace

TableScript

Assembly

TableScript.dll

Main class that represents a ready to run script and manages most of the public API

public class Script

Inheritance

object

Script

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

OnReport

Action that will be called on error

public Action<TableScriptException> OnReport

Field Value

Action<TableScriptException>

Properties

filename

public string filename { get; }

Property Value

string

functions

public BoundFunc[] functions { get; }

Property Value

BoundFunc[]

Methods

CallFunction(string, string, params Table[])

Always call after running!

public Table CallFunction(string import, string identifier, params Table[] args)

Parameters

import string

identifier string

args Table[]

Returns

Table

FromImport(ResolvedImport, IImportResolver, Action<TableScriptException>, Optimizations)

Generate from import.

public static Script FromImport(ResolvedImport import, IImportResolver ir, Action<TableScriptException> report, Optimizations optimizations = Optimizations.Normal)

Parameters

import ResolvedImport

ir IImportResolver

report Action<TableScriptException>

optimizations Optimizations

Returns

Script

Exceptions

TableScriptException

Thrown when an error occurs while compiling

FromImport(ResolvedImport, IImportResolver, Optimizations)

Generate from import

public static Script FromImport(ResolvedImport import, IImportResolver ir, Optimizations optimizations = Optimizations.Normal)

Parameters

import ResolvedImport

ir IImportResolver

optimizations Optimizations

Returns

Script

Exceptions

TableScriptException

Thrown when an error occurs while compiling

FromImport(ResolvedImport, Optimizations)

Generate from import. Will use a default StandardImportResolver

public static Script FromImport(ResolvedImport import, Optimizations optimizations = Optimizations.Normal)

Parameters

import ResolvedImport

optimizations Optimizations

Returns

Script

Exceptions

TableScriptException

Thrown when an error occurs while compiling

FromSource(string, string, IImportResolver, Action<TableScriptException>, Optimizations)

Generate from source

public static Script FromSource(string filename, string src, IImportResolver ir, Action<TableScriptException> report, Optimizations optimizations = Optimizations.Normal)

Parameters

filename string

src string

ir IImportResolver

report Action<TableScriptException>

optimizations Optimizations

Returns

Script

Exceptions

TableScriptException

Thrown when an error occurs while compiling

FromSource(string, string, IImportResolver, Optimizations)

Generate from source

public static Script FromSource(string filename, string src, IImportResolver ir, Optimizations optimizations = Optimizations.Normal)

Parameters

filename string

src string

ir IImportResolver

optimizations Optimizations

Returns

Script

Exceptions

TableScriptException

Thrown when an error occurs while compiling

FromSource(string, string, Optimizations)

Generate from source. Will use a default StandardImportResolver

public static Script FromSource(string filename, string src, Optimizations optimizations = Optimizations.Normal)

Parameters

filename string

src string

optimizations Optimizations

Returns

Script

Exceptions

TableScriptException

Thrown when an error occurs while compiling

Run(IEnumerable<string>)

Run the script

public void Run(IEnumerable<string> args)

Parameters

args IEnumerable<string>

Run(Table)

Run the script

public void Run(Table args = null)

Parameters

args Table

SourceAsImport(string, string, Action<TableScriptException>, Optimizations)

Generate an import from source

public static ResolvedImport SourceAsImport(string filename, string src, Action<TableScriptException> report, Optimizations optimizations = Optimizations.Normal)

Parameters

filename string

src string

report Action<TableScriptException>

optimizations Optimizations

Returns

ResolvedImport

Exceptions

TableScriptException

Thrown when an error occurs while compiling

SourceAsImport(string, string, Optimizations)

Generate an import from source

public static ResolvedImport SourceAsImport(string filename, string src, Optimizations optimizations = Optimizations.Normal)

Parameters

filename string

src string

optimizations Optimizations

Returns

ResolvedImport

Exceptions

TableScriptException

Thrown when an error occurs while compiling

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.