Plugins

Technical reference only.

See the Guides for usage examples and system flow.

Handles external plugin hook registration and execution. Used by internal systems and plugins to hook into the player object lifecycle and inject behaviours.

The plugins module is only required for extending or modifying the player object during its lifecycle. Internal systems and external plugins use it to inject custom behaviour during player initialization (e.g., adding extensions, methods, or syncing data).

---

register

Registers a plugin hook function to run during player initialization.

plugins.register(name, fn, priority)

Parameters

• name (string): Unique name for the plugin.

• fn (function): Function to execute.

• priority (number|nil): Optional loading priority. Lower values run earlier.

---

run

Executes all registered plugin hooks for a given player object.

plugins.run(player)

Parameters

• player (table): The player object to pass into each hook.

---

has_executed

Checks if a specific plugin hook has already run.

plugins.has_executed(name)

Parameters

• name (string): The plugin name to check.

Returns

• boolean: True if the plugin has been executed.

---

clear

Clears all registered hooks and their execution state.

plugins.clear()

Description

Resets the hook system, removing all previously registered hooks and clearing execution records.