API Host ScriptContext

ScriptContext

Execution context passed to advanced host callbacks and compiled block invocations.

Namespace: AuroraScript.Runtime. Kind: class.

Back to .NET Host API Reference

Overview

Execution context passed to advanced host callbacks and compiled block invocations.

Use this type mainly for custom CLR callbacks and advanced closure invocation.

Quick Reference

A minimal use of ScriptContext.

// Given a configured AuroraEngine named engine:
using var domain = engine.CreateDomain();

var context = new ScriptContext(domain);
Console.WriteLine(context.Domain == domain); // True

Constructors

ScriptContext(ScriptDomain domain)

Creates a ScriptContext instance.

ScriptContext(ScriptDomain domain)

Parameters

Name	Type	Required	Description
domain	ScriptDomain	Yes	Execution domain associated with the context.

Returns

A new ScriptContext instance.

ScriptContext(ScriptDomain domain, ScriptObject userState)

Creates a ScriptContext instance.

ScriptContext(ScriptDomain domain, ScriptObject userState)

Parameters

Name	Type	Required	Description
domain	ScriptDomain	Yes	Execution domain associated with the context.
userState	ScriptObject	Yes	Optional host state available during execution.

Returns

A new ScriptContext instance.

Properties

Domain

ScriptDomain Domain

Parameters

None.

Returns

Returns ScriptDomain.

Engine

AuroraEngine Engine

Parameters

None.

Returns

Returns AuroraEngine.

Global

ScriptGlobal Global

Parameters

None.

Returns

Returns ScriptGlobal.

Module

ScriptModule Module

Parameters

None.

Returns

Returns ScriptModule.

UserState

ScriptObject UserState

Parameters

None.

Returns

Returns ScriptObject.

Target

ClosureFunction Target

Parameters

None.

Returns

Returns ClosureFunction.

Location

long Location

Parameters

None.

Returns

Returns long.

Methods

With

ScriptContext With(ScriptModule module, ClosureFunction closure = null)

ScriptContext With(ClosureFunction closure)

ScriptContext With(ScriptModule module, ClosureFunction closure, ScriptObject userState)

• ScriptContext With(ScriptModule module, ClosureFunction closure = null)
• ScriptContext With(ClosureFunction closure)
• ScriptContext With(ScriptModule module, ClosureFunction closure, ScriptObject userState)

Parameters

Name	Type	Required	Description
module	ScriptModule	Varies	Script module to associate or execute.
closure	ClosureFunction	Varies	Closure function to invoke.
userState	ScriptObject	Varies	User state associated with the execution context.

Returns

Returns ScriptContext.

CallStack

AuroraStackTrace[] CallStack()

Parameters

None.

Returns

Returns AuroraStackTrace[].

StackTrace

List<AuroraStackTrace> StackTrace()

Parameters

None.

Returns

Returns List<AuroraStackTrace>.