Standard and Low Level methods and properties for querying/interacting with the NwScript virtual machine. More...

Inheritance diagram for Anvil.API.VirtualMachine:

Collaboration diagram for Anvil.API.VirtualMachine:

Public Member Functions
void	Execute (string scriptName, NwObject? target, params(string ParamName, string ParamValue)[] scriptParams)
	Executes the specified NWN script. If scriptName does not specify a compiled script, nothing happens.

void	Execute (string scriptName, params(string ParamName, string ParamValue)[] scriptParams)
	Executes the specified NWN script. If scriptName does not specify a compiled script, nothing happens.

void	ExecuteInScriptContext (System.Action action, uint objectId=NwObject.Invalid, int scriptEventId=0)

T	ExecuteInScriptContext< T > (System.Func< T > action, uint objectId=NwObject.Invalid, int scriptEventId=0)

string?	GetCurrentScriptName (int depth=0)
	Gets the name of the currently executing script. If depth is > 0, it will return the name of the script that called this one via ExecuteScript().

Properties
EventScriptType	CurrentRunningEvent `[get, set]`
	Gets or sets the current running script event.

uint	InstructionLimit `[get, set]`
	Gets or sets the instruction limit for the NWScript VM.

uint	InstructionsExecuted `[get, set]`

bool	IsInScriptContext `[get]`
	Returns true if the current executing code is being executed on the main thread, and in a Virtual Machine script context.

int	RecursionLevel `[get]`

bool	ScriptReturnValue `[get]`

Detailed Description

Standard and Low Level methods and properties for querying/interacting with the NwScript virtual machine.

Member Function Documentation

string? Anvil.API.VirtualMachine.GetCurrentScriptName ( int depth = 0 )

inline

Gets the name of the currently executing script.
If depth is > 0, it will return the name of the script that called this one via ExecuteScript().

Parameters

depth depth to seek the executing script.

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