plugins

Documentation

Index

• Variables
• func GetScriptLoadPaths() []string
• func LoadClient(eng *lua.Engine) error
• func LoadCommands(eng *lua.Engine) error
• func LoadServer(eng *lua.Engine) error
• func LoadViews() error

Variables

var (
	// Paths lists the filepaths for all accessible plugins in the current
	// project directory.
	Paths []string

	// Root is the root path of the project directory
	Root string

	// PluginRoot is the root for all plugins, essnetially just
	// Root + "/plugins"
	PluginRoot string

	// GameRoot is the root for all player written game files, essentially just
	// Root + "/game"
	GameRoot string

	// Names is a list of names for each of the plugins loaded.
	Names []string
)

Functions

func GetScriptLoadPaths

func GetScriptLoadPaths() []string

GetScriptLoadPaths returns the paths used for loading scripts via Lua. This is converting all plugin paths into ?.lua and ?/init.lua paths.

func LoadClient

func LoadClient(eng *lua.Engine) error

LoadClient runs all the init.lua files for client in the users codebase and with all plugins.

func LoadCommands

func LoadCommands(eng *lua.Engine) error

LoadCommands runs all the init.lua files for commands in the users codebase and with all plugins.

func LoadServer

func LoadServer(eng *lua.Engine) error

LoadServer runs all the init.lua files for server in the users codebase and with all plugins.

func LoadViews

func LoadViews() error

LoadViews will read all plugin views and compile them, then perform the sam eoperation on root views. Root view definitions can overwrite