Erebot\Interfaces\Event\Base\Generic Interface Reference

Interface for a generic Event. More...

Inherited by Erebot\Event\AbstractEvent, Erebot\Interfaces\Event\Base\Ban, Erebot\Interfaces\Event\Base\Chan, Erebot\Interfaces\Event\Base\ChanModeGiven, Erebot\Interfaces\Event\Base\ChanModeTaken, Erebot\Interfaces\Event\Base\Ctcp, Erebot\Interfaces\Event\Base\Except, Erebot\Interfaces\Event\Base\Halfop, Erebot\Interfaces\Event\Base\MessageCapable, Erebot\Interfaces\Event\Base\Op, Erebot\Interfaces\Event\Base\Owner, Erebot\Interfaces\Event\Base\PrivateMessage, Erebot\Interfaces\Event\Base\Protect, Erebot\Interfaces\Event\Base\Source, Erebot\Interfaces\Event\Base\Target, Erebot\Interfaces\Event\Base\Text, Erebot\Interfaces\Event\Base\Voice, Erebot\Interfaces\Event\Connect, Erebot\Interfaces\Event\Disconnect, Erebot\Interfaces\Event\ExitEvent, Erebot\Interfaces\Event\Logon, Erebot\Interfaces\Event\Numeric, and Erebot\Interfaces\Event\ServerCapabilities.

Public Member Functions
	getConnection ()
	preventDefault ($prevent=null)

Detailed Description

Interface for a generic Event.

Definition at line 27 of file Generic.php.

Member Function Documentation

Erebot\Interfaces\Event\Base\Generic::getConnection

(

)

Returns the connection this event came from. This is the same object as that passed during construction.

Return values

Erebot::Interfaces::Connection

The connection this event came from.

Implemented in Erebot\Event\Numeric, and Erebot\Event\AbstractEvent.

Erebot\Interfaces\Event\Base\Generic::preventDefault

(

$prevent = null

)

Prevents the default action associated with this type of event from occuring.

Parameters

mixed

$prevent

(optional) Whether the default action should be prevented (true) or not (false). You may also pass the value null to retrieve the current value without modifying it.

Return values

bool	Previous value (if modified by this call), or current value (if the value null was passed to $prevent).

Implemented in Erebot\Event\Numeric, and Erebot\Event\AbstractEvent.

---

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

• vendor/erebot/api/src/Interfaces/Event/Base/Generic.php