API reference

script_engine.h · C++ API

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

include/kui/script/script_engine.h
ScriptEngine::~ScriptEngine
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual ~ScriptEngine() = default;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:48

Report an issue with this entry →
ScriptEngine::bindDocument
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void bindDocument(Document* doc) = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:50

Report an issue with this entry →
ScriptEngine::callFunction
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual ScriptResult callFunction(const String& name, const std::vector<ScriptValue>& args = {}) = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:69

Report an issue with this entry →
ScriptEngine::create
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
static std::unique_ptr<ScriptEngine> create();

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:213

Report an issue with this entry →
ScriptEngine::debuggerPtr
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void* debuggerPtr()

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:144

Report an issue with this entry →
ScriptEngine::eval
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual ScriptResult eval(const String& code, const String& sourceName = "<eval>") = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:60

Report an issue with this entry →
ScriptEngine::evalFile
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual ScriptResult evalFile(const String& path) = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:66

Report an issue with this entry →
ScriptEngine::evaluateForDevTools
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual String evaluateForDevTools(const String& expr)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:106

Report an issue with this entry →
ScriptEngine::executeScripts
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void executeScripts()

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:84

Report an issue with this entry →
ScriptEngine::getGlobal
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual ScriptValue getGlobal(const String& name) = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:82

Report an issue with this entry →
ScriptEngine::hasPendingAnimationFrameCallback
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual bool hasPendingAnimationFrameCallback() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:149

Report an issue with this entry →
ScriptEngine::hasPendingCallbacks
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual bool hasPendingCallbacks() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:90

Report an issue with this entry →
ScriptEngine::instructionLimit
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual uint64_t instructionLimit() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:133

Report an issue with this entry →
ScriptEngine::interopBridge
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual const InteropBridge* interopBridge() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:104

Report an issue with this entry →
ScriptEngine::interopBridge
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual InteropBridge* interopBridge()

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:101

Report an issue with this entry →
ScriptEngine::isExecuting
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual bool isExecuting() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:189

Report an issue with this entry →
ScriptEngine::loadedScriptSources
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual std::vector<ScriptSourceInfo> loadedScriptSources() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:142

Report an issue with this entry →
ScriptEngine::memoryLimitBytes
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual size_t memoryLimitBytes() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:132

Report an issue with this entry →
ScriptEngine::memoryUsageBytes
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual size_t memoryUsageBytes() const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:116

Report an issue with this entry →
ScriptEngine::nextTimerDeadlineMs
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual f64 nextTimerDeadlineMs(f64 nowMs) const

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:170

Report an issue with this entry →
ScriptEngine::registerFunction
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void registerFunction(const String& name, ScriptValue::FunctionType fn) = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:73

Report an issue with this entry →
ScriptEngine::setErrorHandler
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
void setErrorHandler(ScriptErrorHandler handler)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:207

Report an issue with this entry →
ScriptEngine::setGlobal
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void setGlobal(const String& name, ScriptValue value) = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:79

Report an issue with this entry →
ScriptEngine::setInstructionLimit
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void setInstructionLimit(uint64_t maxOps)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:131

Report an issue with this entry →
ScriptEngine::setMemoryLimit
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void setMemoryLimit(size_t bytes)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:119

Report an issue with this entry →
ScriptEngine::setPrintHandler
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void setPrintHandler(PrintHandler handler)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:99

Report an issue with this entry →
ScriptEngine::tickTimers
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void tickTimers(f64 nowMs)

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:87

Report an issue with this entry →
ScriptEngine::unbindDocument
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
virtual void unbindDocument() = 0;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:56

Report an issue with this entry →
ScriptEngine::void
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
using PrintHandler = std::function<void(const String& message)>;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:96

Report an issue with this entry →
void
Needs verification3.61.7C++

Installed header declaration in the script module. The signature is shown as declared. Check the owning type for lifetime, threading and platform requirements.

script_engine.h
using ScriptErrorHandler = std::function<void(const String& error, const String& source, int line)>;

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

include/kui/script/script_engine.h:28

Report an issue with this entry →
Browse this reference type →