Hooks
Updated for version 3.38.
Module Definition
The module inherits ModuleBase. All parameters and functions of this class are inherited by the module.
Module name
The name of the module you use as the meta of the module definition is 'Hooks' or 'HooksModule' if _force_search
is set to true in the module definition.
XML Structure
<Hooks directory type>
Parameter | Type | Description |
---|---|---|
directory | String | Directory/path relative to the mods directory which contains all the hooked. [OPTIONAL] |
<hook type file source_file use_clbk/>
Parameter | Type | Description |
---|---|---|
source_file | String | The path of the lua source file you wish to hook to. [REQ] |
file | String | File path of the file that is hooking to the |
Both
Parameter | Type | Description |
---|---|---|
type | String | The type of hook. If this is set to |
pre | Boolean | Like |
post | Boolean | Like |
Example
This example is what you would put inside your main node within your mod config
And if you are using the use_clbk, have something like this:
For this example your hook will be here: mods/MyMod/Hooks/Setup.lua
. If you are using this module in a BLT mod.
<hooks>
example
<hooks>
exampleNow it will be in: mods/MyMod/Hooks/Other/Setup.lua
.
Functions
Functions
Function | Description |
---|---|
Load(Table config, String prev_div) | Called normally by the module's init function. This is what adds the hooks. |
GetPath(String directory, String prev_dir) | Joins directory and prev_dir. If prev_dir is not present returns directory alone. Used by the Load function |
Last updated