Sandbox: Lua: Engine - ov-studio/Vital.sandbox GitHub Wiki

━ What's the Objective?

Vital exposes engine/application's specific APIs for sandboxing purposes.

━ APIs

━ engine.getSystemTick() (Shared)

@Objective: Retrieves system's tick.

local int: result = engine.getSystemTick()

---

━ engine.getApplicationTick() (Shared)

@Objective: Retrieves application's tick.

local int: result = engine.getApplicationTick()

---

━ engine.getClientTick() (Client)

@Objective: Retrieves client's tick.

local int: result = engine.getClientTick()

---

━ engine.loadString() (Shared)

@Objective: Loads the buffer into the VM.

local bool: result = engine.loadString(string: buffer)

---

━ engine.bindKey() (Shared)

@Objective: Binds specified handler to provided key.

local bool: state = engine.bindKey(
  string: key,
  function: exec
)

---

━ engine.unbindKey() (Shared)

@Objective: Unbinds specified handler from provided key.

local bool: state = engine.unbindKey(
  string: key,
  function: exec
)

---

━ engine.executeBindKey() (Shared)

@Objective: Executes a bind key explicitly.

local bool: state = engine.executeBindKey(
  string: key
)

---

━ engine.bindCommand() (Shared)

@Objective: Binds specified handler to provided command.

local bool: state = engine.bindCommand(
  string: command,
  function: exec
)

---

━ engine.unbindCommand() (Shared)

@Objective: Unbinds specified handler from provided command.

local bool: state = engine.unbindCommand(
  string: command,
  function: exec
)

---

━ engine.executeBindCommand() (Shared)

@Objective: Executes a bind command explicitly.

local bool: state = engine.executeBindCommand(
  string: command
)