plugin

Documentation

Index

• func NewState(callStackSize int, registrySize int) *lua.LState
• type Config
• type Globals
• type Plugin
  • func Load(conf *Config) (*Plugin, error)
  • func (p *Plugin) Close()
  • func (p *Plugin) Run() error
  • func (p *Plugin) SetGlobal(name string, val interface{})
• type Timers
  • func (t *Timers) AfterFunc(ms int, f func()) func() bool
  • func (t *Timers) ImportTo(ls *lua.LState)
  • func (t *Timers) Stop()

Functions

func NewState

func NewState(callStackSize int, registrySize int) *lua.LState

NewState prepares a new Lua environment

Types

type Config

type Config struct {
	Path          string
	CallStackSize int
	RegistrySize  int
}

Config stores the configuration of a single plugin

type Globals

type Globals map[string]interface{}

Globals stores shared variables

type Plugin

type Plugin struct {
	*lua.LState

	// Set once before Run(), read-only after that
	*Config
	// contains filtered or unexported fields
}

Plugin loads and executes a lua script

func Load

func Load(conf *Config) (*Plugin, error)

Load a lua plugin

func (*Plugin) Close

func (p *Plugin) Close()

Close plugin

func (*Plugin) Run

func (p *Plugin) Run() error

Run plugin

func (*Plugin) SetGlobal

func (p *Plugin) SetGlobal(name string, val interface{})

SetGlobal variable

type Timers

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

Timers registers all active timers

func (*Timers) AfterFunc

func (t *Timers) AfterFunc(ms int, f func()) func() bool

AfterFunc waits for the duration to elapse and then calls f in its own goroutine see time.AfterFunc

func (*Timers) ImportTo

func (t *Timers) ImportTo(ls *lua.LState)

ImportTo Lua state

func (*Timers) Stop

func (t *Timers) Stop()

Stop all timers