Erebot\Interfaces\HelpEnabled Interface Reference

Interface for a module that implements an help method. More...

Public Member Functions
	getHelp (\Erebot\Interfaces\Event\Base\TextMessage $event,\Erebot\Interfaces\TextWrapper $words)

Detailed Description

Interface for a module that implements an help method.

This interface provides an help method for Erebot's modules. Such a method is called when some user requests help on the module or a command provided by the bot.

Definition at line 31 of file HelpEnabled.php.

Member Function Documentation

Erebot\Interfaces\HelpEnabled::getHelp	(	\Erebot\Interfaces\Event\Base\TextMessage	$event,
		\Erebot\Interfaces\TextWrapper	$words
	)

Provides help about the current module.

Parameters

Erebot::Interfaces::Event::Base::TextMessage	$event	Some help request.
Erebot::Interfaces::TextWrapper	$words	Parameters passed with the help request. This is the same as the module's name when help is requested on the module itself (as opposed to help on a specific command provided by the module).

Return values

boolean

(optional) Indicates whether the help request was handled by this method (true) or not (false). Unhandled help requests are passed to the next help method registered until either some help method handles the request or all methods have been tried with no success. If omitted, false is assumed.

---

The documentation for this interface was generated from the following file:

• vendor/erebot/api/src/Interfaces/HelpEnabled.php