lia.module

Core library that manages module loading behaviors.

If you are looking for the module structure, you can find it here.

Functions

OnFinishLoad(uniqueID, path, category, firstLoad)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads a module's submodules if present. This function handles the loading of a module's submodules, if they exist.

Parameters

  • uniqueID String

    The unique identifier for the module.

  • path String

    The path to the module.

  • category String

    The category of the module.

  • firstLoad Boolean

    Indicates if this is the first load of the module.

get(identifier)

Retrieves a module. This function retrieves a module table based on its identifier.

Parameters

  • identifier String

    The identifier of the module.

Returns

  • any

    table The module object.

initialize(firstLoad)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads and initializes the modules. This function loads and initializes modules located under their respective folders.

Parameters

  • firstLoad Boolean

    Indicates if this is the first load of the modules.

load(uniqueID, path, isSingleFile, variable, category, firstLoad)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads a module into the system. This function loads a module into the system, making its functionality available. It sets up the module environment, including defining globals and loading necessary files.

Parameters

  • uniqueID String

    The unique identifier of the module.

  • path String

    The path to the module.

  • isSingleFile Boolean

    Specifies if the module is contained in a single file.

  • variable String

    The variable name to assign the module to.

  • category String

    The category of the module.

  • firstLoad Boolean

    Indicates if this is the first load of the module.

loadDependencies(Dependencies)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads module dependencies. This function loads the dependencies for the module.

Parameters

  • Dependencies

    The dependencies to load.

loadExtras(path)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads the additional files associated with the module. This function loads extra files tied to the module, such as language files, factions, classes, and attributes.

Parameters

  • path String

    The path to the module directory.

loadFromDir(directory, group, category, firstLoad)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads modules from a directory. This function loads modules from a specified directory into the system.

Parameters

  • directory String

    The path to the directory containing modules.

  • group String

    The group of the modules (e.g., "schema" or "module").

  • category String

    The category of the modules.

  • firstLoad Boolean

    Indicates if this is the first load of the modules.

loadPermissions(Privileges)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads permissions. This function loads permissions for the module.

Parameters

  • Privileges

    The privileges to load. This is the MODULE.CAMIPrivileges.

loadWorkshop(Workshop)

Internal

This is an internal function! You are able to use it, but you risk unintended side effects if used incorrectly.

Loads workshop content. This function loads workshop content for the module.

Parameters

  • Workshop

    The workshop content to load. This is the MODULE.WorkshopContent.