Skip to content

include⚓︎

Loads the given module. This functions identically to require, but will return nil instead of erroring if the module couldn't be found. If there is another error is found inside the included file, it will still cause an error in the includeing file.

The function starts by looking into the package.loaded table to determine whether modname is already loaded. If it is, then include returns the value stored at package.loaded[modname]. Otherwise, it tries to find a loader for the module.

Intended use case for this function is for making interoperability between mods.

local result = include(modname)

Parameters:

  • modname (string)

Returns:

  • result (table, nil)
Example: Example

How to check whether a user has an optional module installed.

local optionalModule = include("optionalModule.file")

if optionalModule then
    -- do stuff with the optinalModule
    optionalModule.foo("bar")
else
    mwse.log("[MyMod] To enjoy all of this mod's features, please install optionalModule.")
    -- do some other stuff
end