Skip to content

nut.plugin

Plugin Module.

Core system for loading and managing NutScript plugins and schema components.

Functions

nut.plugin.load (uniqueID, path, isSingleFile, variable)
nut.plugin.load

Loads a plugin from specified path

Parameters:

string uniqueID Unique plugin identifier

string path Path to plugin directory

boolean isSingleFile optional. default: false Whether loading single file

string variable optional. default: "PLUGIN" Global variable name

Usage:

    1
    nut.plugin.load("myplugin", "plugins/myplugin")

nut.plugin.loadExtras (path)
nut.plugin.loadExtras

Loads additional plugin resources

Parameters:

string path Base plugin path

Usage:

    1
    nut.plugin.loadExtras("plugins/myplugin")

nut.plugin.loadEntities (path)
nut.plugin.loadEntities

Loads entities from plugin directory

Parameters:

string path Path to entities directory

Usage:

    1
    nut.plugin.loadEntities("plugins/myplugin/entities")

nut.plugin.initialize ()
nut.plugin.initialize

Internal

This is used internally - although you're able to use it you probably shouldn't.

Initializes core plugin system

Usage:

    1
    nut.plugin.initialize()

nut.plugin.loadFromDir (directory)
nut.plugin.loadFromDir

Loads all plugins from directory

Parameters:

string directory Directory to scan

Usage:

    1
    nut.plugin.loadFromDir("plugins")

nut.plugin.setDisabled (uniqueID, disabled)
nut.plugin.setDisabled

Sets plugin disabled state

Parameters:

string uniqueID Plugin identifier

boolean disabled Whether to disable

Usage:

    1
    nut.plugin.setDisabled("myplugin", true)

nut.plugin.isDisabled (uniqueID)
nut.plugin.isDisabled

Checks if plugin is disabled

Parameters:

string uniqueID Plugin identifier

Returns:

bool Disabled status

Usage:

    1
    if nut.plugin.isDisabled("myplugin") then return end

Tables

PluginDef
PluginDef

Plugin Definition Structure

Fields:

vararg uniqueID Unique string identifier

vararg name Display name

vararg desc Description text

vararg author Author name

vararg folder Plugin directory path

vararg loading Loading state flag