FrameworkZ API Documentation - FrameworkZ.Plugins

Home / FrameworkZ.Plugins Module

FrameworkZ.Plugins

module

Plugins module for FrameworkZ. Extends the framework with modular plugins.

0
Functions
15
Methods
1
Fields

📋 On This Page

Fields

1
FrameworkZ.Plugins 📋 table
Plugins module for FrameworkZ. Extends the framework with modular plugins.
Initial value: {}

Methods

15

FrameworkZ.Plugins:AddEventHandler(eventName)

method
Add a new event handler to the list.

Parameters

eventName 📝 string
The name of the event handler to add.

FrameworkZ.Plugins:CreatePlugin(name)

method undocumented
No documentation available

Parameters (inferred)

name ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Plugins:ExecuteCommand(commandName, ...)

method
Execute a custom command.

Parameters

commandName 📝 string
The name of the command.

FrameworkZ.Plugins:ExecutePluginHook(hookName, ...)

method
Execute a hook for all loaded plugins.

Parameters

hookName 📝 string
The name of the hook to execute.

FrameworkZ.Plugins:GetPlugin(pluginName)

method undocumented
No documentation available

Parameters (inferred)

pluginName ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Plugins:LoadPlugin(pluginName)

method
Load a registered plugin.

Parameters

pluginName 📝 string
The name of the plugin to load.

FrameworkZ.Plugins:Log(message)

method
Log a message for debugging purposes.

Parameters

message 📝 string
The message to log.

FrameworkZ.Plugins:RegisterCommand(commandName, callback)

method
Register a custom command for a plugin.

Parameters

commandName 📝 string
The name of the command.
callback ⚡ function
The function to call when the command is executed.

FrameworkZ.Plugins:RegisterInterface(interfaceName, interfaceTable)

method undocumented
No documentation available

Parameters (inferred)

interfaceName ❓ unknown
Parameter inferred from function signature
interfaceTable ❓ unknown
Parameter inferred from function signature

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Plugins:RegisterPlugin(plugin, overwrite)

method
Register a plugin.

Parameters

pluginName 📝 string
The name of the plugin.
pluginTable 📋 table
The table containing the plugin's functions and data.
metadata 📋 table
Optional metadata for the plugin.

FrameworkZ.Plugins:RegisterPluginEventHandlers(plugin)

method
Register event handlers for a plugin.

Parameters

plugin 📋 table
The plugin table containing the functions.

FrameworkZ.Plugins:RemoveEventHandler(eventName)

method
Remove an event handler from the list.

Parameters

eventName 📝 string
The name of the event handler to remove.

FrameworkZ.Plugins:UnloadPlugin(pluginName)

method
Unload a loaded plugin.

Parameters

pluginName 📝 string
The name of the plugin to unload.

FrameworkZ.Plugins:UnregisterPluginEventHandlers(plugin)

method
Unregister event handlers for a plugin.

Parameters

plugin 📋 table
The plugin table containing the functions.

FrameworkZ.Plugins:UnregisterPluginHook(pluginName, hookName)

method
Unregister a specific hook for a plugin.

Parameters

pluginName 📝 string
The name of the plugin.
hookName 📝 string
The name of the hook to unregister.