lua

package

v0.12.3 Latest Latest Go to latest Published: Mar 13, 2026 License: MIT Imports: 9 Imported by: 0

Documentation ¶

This section is empty.

This section is empty.

This section is empty.

type Manager struct {
	// contains filtered or unexported fields
}

Manager coordinates multiple sandboxed Lua states.

func NewManager(logger *log.Loggee) *Manager

NewManager creates a manager with an optional logger. When logger is nil, scripting logs are dropped.

func (m *Manager) Close()

Close stops all persistent instances managed by this manager.

func (m *Manager) CreatePersistent(code string, opts Options) (string, error)

CreatePersistent compiles the provided script once and returns an ID that can be rerun later.

func (m *Manager) DestroyPersistent(id string)

DestroyPersistent removes the persistent VM identified by id.

func (m *Manager) RegisterFunction(name string, fn lua.LGFunction)

RegisterFunction exposes a Go function to all future Lua states managed by this manager.

func (m *Manager) RunPersistent(id string) error

RunPersistent executes the persistent VM associated with id.

func (m *Manager) RunVolatile(code string, opts Options) error

RunVolatile creates a temporary VM, executes the script, and destroys it afterwards.

func (m *Manager) SetDefaultSender(sender string)

SetDefaultSender overrides the sender name used when logging from scripts.

type Options struct {
	Name      string
	Functions map[string]lua.LGFunction
	Globals   map[string]lua.LValue
	Mode      VMMode
}

Options configure a Lua VM creation.

type VMMode uint8

const (
	Sandboxed VMMode = iota
	Elevated
	Unsafe
)