Skip to content

ax.module

Module management system for loading and retrieving modules.

Documented functions: 5  ·  Realm: shared

Functions

ax.module:Get(name)

Get a loaded module by its unique identifier.

Retrieves a module that has been previously loaded.

Realm: shared

Parameters

Name Type Description
name string The module's unique identifier

Returns

  • table|nil: The module table if found, nil otherwise

Usage

local myModule = ax.module:Get("example_module")

Source: gamemode/framework/libraries/sh_module.lua:180

ax.module:GetAll()

Get all loaded modules.

Realm: shared

Returns

  • table: Map of unique id -> module table

Usage

local modules = ax.module:GetAll()

Source: gamemode/framework/libraries/sh_module.lua:196

ax.module:GetByScope(scope)

Get modules filtered by scope.

Realm: shared

Parameters

Name Type Description
scope string Scope to filter by ("framework" or "schema")

Returns

  • table: Map of unique id -> module table

Usage

local schemaModules = ax.module:GetByScope("schema")

Source: gamemode/framework/libraries/sh_module.lua:205

ax.module:Include(path, timeFilter)

Include and load modules from a directory path.

Automatically loads both single-file modules and directory-based modules with boot.lua.

For directory modules, includes all standard framework directories in proper order.

Realm: shared

Parameters

Name Type Description
path string The directory path to search for modules

Usage

ax.module:Include("parallax/gamemode/modules")

Source: gamemode/framework/libraries/sh_module.lua:25

ax.module:IsLoaded(name)

Check if a module is loaded.

Tests whether a module with the given name has been successfully loaded.

Realm: shared

Parameters

Name Type Description
name string The module's unique identifier

Returns

  • boolean: True if the module is loaded, false otherwise

Usage

if ax.module:IsLoaded("example_module") then print("Module available") end

Source: gamemode/framework/libraries/sh_module.lua:227