Added OnMapEnd listener which, unlike OnLevelShutdown, will never get called more than once.

Author: L'In20Cible

addons/source-python/packages/source-python/listeners/__init__.py

@@ -80,6 +80,7 @@
            'OnEntitySpawned',
            'OnLevelInit',
            'OnLevelShutdown',
+           'OnMapEnd',
            'OnNetworkidValidated',
            'OnPluginLoaded',
            'OnPluginUnloaded',
@@ -104,6 +105,7 @@
            'on_entity_output_listener_manager',
            'on_entity_pre_spawned_listener_manager',
            'on_entity_spawned_listener_manager',
+           'on_map_end_listener_manager',
            'on_level_init_listener_manager',
            'on_level_shutdown_listener_manager',
            'on_network_id_validated_listener_manager',
@@ -126,6 +128,7 @@
 on_convar_changed_listener_manager = ListenerManager()
 on_plugin_loaded_manager = ListenerManager()
 on_plugin_unloaded_manager = ListenerManager()
+on_map_end_listener_manager = ListenerManager()
 
 _check_for_update = ConVar(
     'sp_check_for_update',
@@ -355,12 +358,23 @@ class OnPluginUnloaded(ListenerManagerDecorator):
     manager = on_plugin_unloaded_manager
 
 
+class OnMapEnd(ListenerManagerDecorator):
+    """Register/unregister a map end listener."""
+
+    manager = on_map_end_listener_manager
+
+    # Guard variable to ensure this listener gets called only once per map.
+    _level_initialized = False
+
+
 # =============================================================================
 # >> CALLBACKS
 # =============================================================================
 @OnLevelInit
 def _on_level_init(map_name):
     """Called when a new map gets initialized."""
+    OnMapEnd._level_initialized = True
+
     if not _check_for_update.get_int():
         return
 
@@ -381,6 +395,20 @@ def _on_level_init(map_name):
         VERSION, version, is_unversioned())
 
 
+@OnLevelShutdown
+def _on_level_shutdown():
+    """Called on level end."""
+    # Was no map initialized?
+    if not OnMapEnd._level_initialized:
+        return
+
+    # Notify all registred callbacks
+    on_map_end_listener_manager.notify()
+
+    # Make sure we don't get called more than once per map change
+    OnMapEnd._level_initialized = False
+
+
 @PreHook(memory.get_virtual_function(cvar, 'CallGlobalChangeCallbacks'))
 def _pre_call_global_change_callbacks(args):
     """Called when a ConVar has been changed."""