13.2. Getting Information About Plugins

All plugins should contain a help function that, when called, prints information about the plugin. If you want to get help on a plugin, call its help function. The example below shows how to call the help of the keypad sec_plugin_

Example 13.3. Getting help about a plugin

Note that the name of the function is prefixed with the name of the plugin and ::. This is a convention so that one plugin's functions do not interfere with other plugins' ones.

It is possible to get a list of all the currently loaded plugins with the $world->listplugin function. If called without arguments, it lists briefly all loaded plugins. But you can pass as argument either a plugin number or a plugin name, and it will give more detailed information about that plugin, including a listing of the triggers, aliases, macros and timers that the plugin defines (if any).