MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 1 | SYNOPSIS |
| 2 | #include <sys/driver_hooks.h> |
| 3 | |
| 4 | set_driver_hook(H_CREATE_SUPER, value) |
| 5 | |
| 6 | <value> being: |
| 7 | |
Zesstra | 8513612 | 2021-05-08 20:32:01 +0200 | [diff] [blame] | 8 | void <name> ( void ) |
MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 9 | int <closure> ( void ) |
| 10 | int <closure> (object obj_to_init) |
| 11 | |
| 12 | DESCRIPTION |
| 13 | Optional hooks to initialize a blueprint which is loaded by |
| 14 | inheritance after creation. |
Zesstra | 7ea4a03 | 2019-11-26 20:11:40 +0100 | [diff] [blame] | 15 | |
Zesstra | daf2c67 | 2025-08-02 15:59:17 +0200 | [diff] [blame] | 16 | Hook setting can be any closure, or the name of the function |
| 17 | (static or public) to call in the object. |
MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 18 | |
Zesstra | daf2c67 | 2025-08-02 15:59:17 +0200 | [diff] [blame] | 19 | If the hook is an unbound lambda closure expecting an argument, |
| 20 | it is bound to the current object and called with the created |
| 21 | object as argument. If the hook is an unbound lambda closure |
| 22 | without arguments, it is bound to the object to be initialized |
| 23 | and called. If the hook is any other type of closure, it is |
| 24 | called with the created object as argument. |
MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 25 | |
| 26 | If the result of the closure call is a non-zero number, it is used |
| 27 | as the interval to wait before the first reset(), else the default |
| 28 | interval computed from TIME_TO_RESET is used. |
| 29 | |
| 30 | If the hook is defined as the name of an lfun in the object, |
Zesstra | 8513612 | 2021-05-08 20:32:01 +0200 | [diff] [blame] | 31 | it is called in the object with no argument and any result |
MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 32 | is ignored. |
| 33 | |
| 34 | HISTORY |
| 35 | LDMud 3.2.10 allowed static functions to be given by name. |
Zesstra | 8513612 | 2021-05-08 20:32:01 +0200 | [diff] [blame] | 36 | LDMud 3.6.5 removed the argument given for the lfun call. |
MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 37 | |
| 38 | SEE ALSO |
Zesstra | 8513612 | 2021-05-08 20:32:01 +0200 | [diff] [blame] | 39 | hooks(C), create_ob(H), create_clone(H), create_lwobject(H) |