From 17bd0719f97fd76c0fcdda1ea9b950b667896b21 Mon Sep 17 00:00:00 2001 From: Andrew Bastien Date: Sun, 19 Nov 2023 12:50:38 -0500 Subject: [PATCH] Documenting SIGNALS_CUSTOM. --- evennia/server/signals.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/evennia/server/signals.py b/evennia/server/signals.py index 21a3bcca9b..3ea79cf564 100644 --- a/evennia/server/signals.py +++ b/evennia/server/signals.py @@ -93,6 +93,11 @@ SIGNAL_CHANNEL_POST_CREATE = Signal() SIGNAL_EXIT_TRAVERSED = Signal() # Used as a generic event emitter. Use to make your own signals easily in one place! +# To use it, import SIGNALS_CUSTOM and use it like a dictionary of Signal objects. +# Example: +# from evennia.utils.signals import SIGNALS_CUSTOM +# SIGNALS_CUSTOM['my_signal'].connect(my_callback) +# SIGNALS_CUSTOM['my_signal'].send(sender, **kwargs) SIGNALS_CUSTOM: dict[str, Signal] = defaultdict(Signal) # Django default signals (https://docs.djangoproject.com/en/4.1/topics/signals/)