Signal

MMO\core\events · 1 symbol · generated 30 Sep 2026

class

Signal

An Event that a listener can answer with a return value (a request/response style event, as opposed to a plain notification) -- the dispatching code calls Send then reads getReturn.

class MMO\core\events\Signal extends MMO\core\events\Event implements MMO\core\interfaces\iSignal

Namespace: MMO\core\events
Extends: Event
Implements: iSignal

class Ask extends Signal {} Ask::AddListener(fn(Ask $e) => $e->setReturn(42)); Ask::Send('origin')->getReturn(); // 42

Index

	returnValue
	getReturn()
	hasReturn()
	setReturn($value, $stop)

Properties1

returnValue

protected mixed $returnValue = null

Type: mixed

Methods3

getReturn()

Signal.php:20

function getReturn(): mixed

returns mixed whatever the last listener to call setReturn passed, or null if none did

hasReturn()

Signal.php:25

function hasReturn(): bool

returns bool true if some listener has called setReturn with a non-null value

setReturn($value, $stop)

Signal.php:34

function setReturn(mixed $value, bool $stop = false): void

$value	mixed
$stop = false	bool	if true and this event also implements iStoppableEvent, stop further listeners from running
returns	void

Inherited members (13)

	Properties	Declared by	Description
	`Listeners`	Event
	`origin`	Event

Methods	Declared by	Description
`AddListener($handler, $order)`	Event	Register a listener directly (as opposed to `ConnectListeners`'s attribute-based discovery).
`ConnectListeners($obj)`	Event	Scan $obj's methods for #[Listen(EventClass::class)] attributes and register each one as a listener on the matching event class.
`DisconnectListeners($obj)`	Event	Undo a previous `ConnectListeners`: removes every listener that `connect` had registered for $obj on this event class.
`dispatch()`	Event	Invoke every `GetListeners` listener with $this.
`GetListeners()`	Event	Collect every listener for this class, including those registered on its parent classes (so a subclass event is also caught by listeners of its parent event), sorted by ascending $order (ties keep …
`getOrigin()`	Event
`HasListener($handler)`	Event
`RemoveListener($handler)`	Event	Remove the last added handler from the listeners.
`Send($args)`	Event	Construct a new instance of this class with $args, then `dispatch` it to every listener.
`SetListenerOrder($handler, $order)`	Event	Change the order of an already-registered listener, whether added directly via `AddListener` or indirectly via `ConnectListeners` (which also stores its `[$obj, $methodName]` callables here).
`__construct($origin)`	Event