Hook

Command words: hook
Permission: SeniorAdmin

This command is used to create and install hooks. Hooks are ways of connecting events (see SHOW EVENTS) and progs (see PROG HELP).

Once you have a prog that matches the right call signature for an event, you create a matching hook. Then, you can install that hook on a character, item, room or the like to ensure that it always fires in response to the event.

Note - you may need to restart the game for some hook-related changes to take effect. Generally it's good practice to reboot after doing anything much which these.

The syntax for this command is as follows:

hook list [<filters>] - lists all of the hooks
hook create <name> <prog> <event> - creates a new hook for an event
hook create <name> <prog> CommandInput|SelfCommandInput <command> - creates a new hook for a command input
hook category <hook> <category> - sets a category for a hook for ease of searching
hook rename <hook> <name> - renames a hook
hook prog <hook> <prog> - changes or toggles the prog payload of a hook
hook command <hook> <command> - changes the command for a command triggered hook
hook install <hook> <target> - installs a hook on a target
hook remove <hook> <target> - removes a hook on a target
hook defaults - shows all default hooks
hook adddefault <perceivable type> <hook> - adds a default hook
hook remdefault <perceivable type> <hook> - removes a default hook

You can use the following filters with hook list:

*<prog> - filters by a prog that the hook calls
<eventtype> - filters by a hook that pertains to the event