docs: add paths field to module interface docs

native-modules
sammyette 2023-07-10 23:24:52 -04:00
parent 3f29dfecb2
commit 3774a77870
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
2 changed files with 4 additions and 0 deletions

View File

@ -24,6 +24,9 @@ https://pkg.go.dev/github.com/arnodel/golua@master/runtime#Runtime
Hilbish uses this package as its Lua runtime. You will need to read
it to use it for a native plugin.
## Interface fields
- `paths`: A list of paths to search when loading native modules.
## Functions
### load(path)
Loads a module at the designated `path`.

View File

@ -10,6 +10,7 @@ import (
// #interface module
// native module loading
// #field paths A list of paths to search when loading native modules.
/* The hilbish.module interface provides a function
to load Hilbish plugins/modules.
Hilbish modules are Go-written plugins (see https://pkg.go.dev/plugin)