Class VisualScripting

The visual scripting runtime service. Allows to execute visual script functions with recursion support and thread-safety.

VisualScripting
Assembly: FlaxEngine.dll
File: Engine/Content/Assets/VisualScript.h
Syntax
public class VisualScripting

Fields

DebugFlow

Declaration
public static Action DebugFlow
Field Value
Action

Methods

Evaluate(VisualScript* script, ScriptingObject* instance, uint32 nodeId, uint32 boxId, Variant& result)

Tries to evaluate a given script box value for the debugger (called usually during the breakpoint on the hanging thread).

Declaration
public static bool Evaluate(VisualScript* script, ScriptingObject* instance, uint32 nodeId, uint32 boxId, Variant& result)
Parameters
VisualScript script

The script.
ScriptingObject instance

The current object instance.
uint32 nodeId

The ID of the node in the script graph to evaluate it's box.
uint32 boxId

The ID of the box in the node to evaluate it's value.
Variant result

The output value. Valid only if method returned true.
Returns
bool

True if could fetch the value, otherwise false.

GetBinaryModule()

Gets the binary module for the Visual Scripting.

Declaration
public static VisualScriptingBinaryModule* GetBinaryModule()
Returns
VisualScriptingBinaryModule

GetStackTrace()

Gets the current stack trace of the current thread Visual Script execution.

Declaration
public static String GetStackTrace()
Returns
String

The stack trace string.

GetThreadStackTop()

Gets the top frame of the current thread Visual Script execution stack frame.

Declaration
public static StackFrame* GetThreadStackTop()
Returns
StackFrame

Invoke(VisualScript::Method* method, ScriptingObject* instance, Span<Variant> parameters=Span<Variant>())

Invokes the specified Visual Script method.

Declaration
public static Variant Invoke(VisualScript::Method* method, ScriptingObject* instance, Span<Variant> parameters=Span<Variant>())
Parameters
VisualScript::Method method

The method to call.
ScriptingObject instance

The object instance. Null for static methods.
Span<Variant> parameters

The input parameters array. Unused if method is parameter-less.
Returns
Variant

The returned value. Undefined if method is void.