![]() |
FrameworkZ 4.4.2
Provides a framework for Project Zomboid with various systems.
|
Foundation for FrameworkZ. More...
Public Member Functions | |
void | AddAllHookHandlers (hookName) |
Add a new hook handler to the list for all categories. | |
void | AddHookHandler (hookName, category) |
Add a new hook handler to the list. | |
void | ExecuteAllHooks (hookName,...) |
Execute all of the hooks. | |
void | ExecuteFrameworkHooks (hookName,...) |
Execute the framework hooks. | |
void | ExecuteGamemodeHooks (hookName,...) |
Execute the gamemode hooks. | |
void | ExecuteGenericHooks (hookName,...) |
Execute generic hooks. | |
void | ExecuteHook (hookName, category,...) |
Execute hooks. | |
void | ExecuteModuleHooks (hookName,...) |
Execute module hooks. | |
void | ExecutePluginHooks (hookName,...) |
Execute plugin hooks. | |
void | GetModule (moduleName) |
table | GetModuleMetaObject (moduleName) |
Get the meta object stored on a module. Not every module will have a meta object. This is a very specific use case and is used for getting instantiable objects such as PLAYER objects or CHARACTER objects. | |
string | GetVersion () |
Get the version of the FrameworkZ Framework. | |
void | InitializeClient () |
table | New () |
Create a new instance of the FrameworkZ Framework. | |
table | NewModule (moduleObject, moduleName) |
Create a new module for the FrameworkZ Framework. | |
void | OnFillInventoryObjectContextMenu (playerID, context, items) |
void | OnGameStart () |
Called when the game starts. Executes the OnGameStart function for all modules. | |
void | OnMainMenuEnter () |
void | OnOpenEscapeMenu () |
void | OnServerStarted () |
Called when the server starts. Executes the OnServerStarted function for all modules. | |
void | PostInitializeClient () |
void | PreInitializeClient () |
void | RegisterFramework () |
void | RegisterFrameworkHandler () |
Register hook handlers for the framework. | |
void | RegisterGamemodeHandler (gamemode) |
Register hook handlers for the gamemode. | |
void | RegisterGenericHandler () |
Register hook handlers for a plugin. | |
void | RegisterHandler (hookName, handler, object, functionName, category) |
Register a handler for a hook. | |
void | RegisterHandlers (objectOrHandlers, category) |
Register handlers for a specific category. | |
void | RegisterModule (module) |
void | RegisterModuleHandler (module) |
Register hook handlers for a module. | |
void | RegisterPluginHandler (plugin) |
Register hook handlers for a plugin. | |
void | RemoveHookHandler (hookName, category) |
Remove a hook handler from the list. | |
void | UnregisterFrameworkHandler () |
Unregister hook handlers for the framework. | |
void | UnregisterGamemodeHandler (gamemode) |
Unregister hook handlers for the gamemode. | |
void | UnregisterGenericHandler () |
Unregister hook handlers for a plugin. | |
void | UnregisterHandler (hookName, handler, object, functionName, category) |
Unregister a handler from a hook. | |
void | UnregisterHandlers (objectOrHandlers, category) |
Unregister handlers for a specific category. | |
void | UnregisterModuleHandler (module) |
Unregister hook handlers for a module. | |
void | UnregisterPluginHandler (plugin) |
Unregister hook handlers for a plugin. | |
Foundation for FrameworkZ.
Definition at line 69 of file 2000_Foundation.lua.
void AddAllHookHandlers | ( | hookName | ) |
Add a new hook handler to the list for all categories.
hookName | string The name of the hook handler to add. |
void AddHookHandler | ( | hookName | , |
category | ) |
void ExecuteAllHooks | ( | hookName | , |
... ) |
Execute all of the hooks.
hookName | string The name of the hook. |
... | \vararg Additional arguments to pass to the hook functions. |
void ExecuteFrameworkHooks | ( | hookName | , |
... ) |
Execute the framework hooks.
hookName | string The name of the hook. |
... | \vararg Additional arguments to pass to the hook functions. |
void ExecuteGamemodeHooks | ( | hookName | , |
... ) |
Execute the gamemode hooks.
hookName | string The name of the hook. |
... | \vararg Additional arguments to pass to the hook functions. |
void ExecuteGenericHooks | ( | hookName | , |
... ) |
Execute generic hooks.
hookName | string The name of the hook. |
... | \vararg Additional arguments to pass to the hook functions. |
void ExecuteHook | ( | hookName | , |
category | , | ||
... ) |
void ExecuteModuleHooks | ( | hookName | , |
... ) |
Execute module hooks.
hookName | string The name of the hook. |
... | \vararg Additional arguments to pass to the hook functions. |
void ExecutePluginHooks | ( | hookName | , |
... ) |
Execute plugin hooks.
hookName | string The name of the hook. |
... | \vararg Additional arguments to pass to the hook functions. |
void GetModule | ( | moduleName | ) |
table GetModuleMetaObject | ( | moduleName | ) |
string GetVersion | ( | ) |
Get the version of the FrameworkZ Framework.
void InitializeClient | ( | ) |
table New | ( | ) |
Create a new instance of the FrameworkZ Framework.
table NewModule | ( | moduleObject | , |
moduleName | ) |
Create a new module for the FrameworkZ Framework.
MODULE_TABLE | table The table to use as the module. |
moduleName | string The name of the module. |
void OnGameStart | ( | ) |
Called when the game starts. Executes the OnGameStart function for all modules.
void OnMainMenuEnter | ( | ) |
void OnOpenEscapeMenu | ( | ) |
void OnServerStarted | ( | ) |
Called when the server starts. Executes the OnServerStarted function for all modules.
void PostInitializeClient | ( | ) |
void PreInitializeClient | ( | ) |
void RegisterFramework | ( | ) |
void RegisterFrameworkHandler | ( | ) |
Register hook handlers for the framework.
framework | table The framework table containing the functions. |
void RegisterGamemodeHandler | ( | gamemode | ) |
Register hook handlers for the gamemode.
module | table The module table containing the functions. |
void RegisterGenericHandler | ( | ) |
Register hook handlers for a plugin.
plugin | table The plugin table containing the functions. |
Register a handler for a hook.
hookName | string The name of the hook. |
handler | function The function to call when the hook is executed. |
object | table (Optional) The object containing the function. |
functionName | string (Optional) The name of the function to call. |
category | string The category of the hook (framework, module, plugin, generic). |
void RegisterHandlers | ( | objectOrHandlers | , |
category | ) |
void RegisterModule | ( | module | ) |
void RegisterModuleHandler | ( | module | ) |
Register hook handlers for a module.
module | table The module table containing the functions. |
void RegisterPluginHandler | ( | plugin | ) |
Register hook handlers for a plugin.
plugin | table The plugin table containing the functions. |
void RemoveHookHandler | ( | hookName | , |
category | ) |
void UnregisterFrameworkHandler | ( | ) |
Unregister hook handlers for the framework.
framework | table The framework table containing the functions. |
void UnregisterGamemodeHandler | ( | gamemode | ) |
Unregister hook handlers for the gamemode.
module | table The module table containing the functions. |
void UnregisterGenericHandler | ( | ) |
Unregister hook handlers for a plugin.
plugin | table The plugin table containing the functions. |
Unregister a handler from a hook.
void UnregisterHandlers | ( | objectOrHandlers | , |
category | ) |
void UnregisterModuleHandler | ( | module | ) |
Unregister hook handlers for a module.
module | table The module table containing the functions. |
void UnregisterPluginHandler | ( | plugin | ) |
Unregister hook handlers for a plugin.
plugin | table The plugin table containing the functions. |