BadScript2.Interactive.BadInteractiveConsoleApi Class Reference

Implements the Interactive Console API. More...

Inheritance diagram for BadScript2.Interactive.BadInteractiveConsoleApi:

Public Member Functions
	BadInteractiveConsoleApi (BadInteractiveConsole console)
	Constructs a new BadInteractiveConsoleApi instance.
Public Member Functions inherited from BadScript2.Runtime.Interop.BadInteropApi
void	LoadRawApi (BadTable target)
	Loads the API into the given Table.
void	Load (BadExecutionContext ctx, BadTable table)
	Loads the API into the given Table.

Protected Member Functions
override void	LoadApi (BadTable target)
Protected Member Functions inherited from BadScript2.Runtime.Interop.BadInteropApi
	BadInteropApi (string name)
	Creates a new Interop API.
void	LoadApi (BadTable target)
	Loads the API into the given Table.

Private Member Functions
void	SetCatchError (bool enable)
	Sets the Catch Error Flag.
void	SetPreParse (bool enable)
	Sets the Pre Parse Flag.
BadObject	GetScope ()
	Returns the Current Scope.

Private Attributes
readonly BadInteractiveConsole	m_Console
	The Console Instance.

Additional Inherited Members
Properties inherited from BadScript2.Runtime.Interop.BadInteropApi
string	Name [get]
	Name of the API.
virtual Version	Version [get]
	The Version of the API.

Detailed Description

Implements the Interactive Console API.

Definition at line 12 of file BadInteractiveConsoleApi.cs.

Constructor & Destructor Documentation

BadInteractiveConsoleApi()

BadScript2.Interactive.BadInteractiveConsoleApi.BadInteractiveConsoleApi

(

BadInteractiveConsole

console

)

Constructs a new BadInteractiveConsoleApi instance.

Parameters

console

The Console Instance

Definition at line 23 of file BadInteractiveConsoleApi.cs.

                                                                   : base("Interactive")
    {
        m_Console = console;
    }

Member Function Documentation

GetScope()

BadObject BadScript2.Interactive.BadInteractiveConsoleApi.GetScope ( )

private

Returns the Current Scope.

Returns

Scope

Definition at line 63 of file BadInteractiveConsoleApi.cs.

    {
        return m_Console.CurrentScope ?? BadObject.Null;
    }

LoadApi()

override void BadScript2.Interactive.BadInteractiveConsoleApi.LoadApi ( BadTable  target )

protected

Definition at line 29 of file BadInteractiveConsoleApi.cs.

    {
        target.SetFunction("Reset", m_Console.Reset);
        target.SetFunction<string>("Run", m_Console.Run);
        target.SetFunction<string>("Load", m_Console.Load);
        target.SetFunction<string>("RunIsolated", m_Console.RunIsolated, BadAnyPrototype.Instance);
        target.SetFunction<string>("LoadIsolated", m_Console.LoadIsolated, BadAnyPrototype.Instance);
        target.SetFunction("GetScope", GetScope, BadScope.Prototype);
        target.SetFunction<bool>("SetCatchError", SetCatchError);
        target.SetFunction<bool>("SetPreParse", SetPreParse);
    }

SetCatchError()

void BadScript2.Interactive.BadInteractiveConsoleApi.SetCatchError ( bool  enable )

private

Sets the Catch Error Flag.

Parameters

enable

State

Definition at line 45 of file BadInteractiveConsoleApi.cs.

    {
        m_Console.CatchErrors = enable;
    }

SetPreParse()

void BadScript2.Interactive.BadInteractiveConsoleApi.SetPreParse ( bool  enable )

private

Sets the Pre Parse Flag.

Parameters

enable

State

Definition at line 54 of file BadInteractiveConsoleApi.cs.

    {
        m_Console.PreParse = enable;
    }

Member Data Documentation

m_Console

readonly BadInteractiveConsole BadScript2.Interactive.BadInteractiveConsoleApi.m_Console

private

The Console Instance.

Definition at line 17 of file BadInteractiveConsoleApi.cs.

---

The documentation for this class was generated from the following file:

• src/BadScript2.Common/BadScript2.Interactive/BadInteractiveConsoleApi.cs