UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add an OnPluginWillUnload callback that precedes OnPluginEnd().

Browse Source
This commit is contained in:
David Anderson 2015-11-01 00:30:37 -07:00
parent d674414cf0
commit c849616003
2 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
core/logic/PluginSys.cpp
View File

@ -1476,6 +1476,14 @@ void CPluginManager::Purge(CPlugin *plugin)
// Go through our libraries and tell other plugins they're gone. // Go through our libraries and tell other plugins they're gone.
plugin->LibraryActions(LibraryAction_Removed); plugin->LibraryActions(LibraryAction_Removed);
// Notify listeners of unloading.
if (plugin->EnteredSecondPass()) {
for (ListenerIter iter(m_listeners); !iter.done(); iter.next()) {
if ((*iter)->GetApiVersion() >= kMinPluginSysApiWithWillUnloadCallback)
(*iter)->OnPluginWillUnload(plugin);
}
}
// We only pair OnPluginEnd with OnPluginStart if we would have // We only pair OnPluginEnd with OnPluginStart if we would have
// successfully called OnPluginStart, *and* SetFailState() wasn't called, // successfully called OnPluginStart, *and* SetFailState() wasn't called,
// which guarantees no further code will execute. // which guarantees no further code will execute.

20
public/IPluginSys.h
View File

@ -38,7 +38,7 @@
#include <sp_vm_api.h> #include <sp_vm_api.h>
#define SMINTERFACE_PLUGINSYSTEM_NAME "IPluginManager" #define SMINTERFACE_PLUGINSYSTEM_NAME "IPluginManager"
#define SMINTERFACE_PLUGINSYSTEM_VERSION 7 #define SMINTERFACE_PLUGINSYSTEM_VERSION 8
/** Context user slot 3 is used Core for holding an IPluginContext pointer. */ /** Context user slot 3 is used Core for holding an IPluginContext pointer. */
#define SM_CONTEXTVAR_USER 3 #define SM_CONTEXTVAR_USER 3
@ -304,6 +304,11 @@ namespace SourceMod
// any plugin for which OnPluginLoaded was called, and is invoked // any plugin for which OnPluginLoaded was called, and is invoked
// immediately after OnPluginEnd(). The plugin may be in any state Failed // immediately after OnPluginEnd(). The plugin may be in any state Failed
// or lower. // or lower.
//
// This function must not cause the plugin to re-enter script code. If
// you wish to be notified of when a plugin is unloading, and to forbid
// future calls on that plugin, use OnPluginWillUnload and use a
// plugin property to block future calls.
virtual void OnPluginUnloaded(IPlugin *plugin) virtual void OnPluginUnloaded(IPlugin *plugin)
{ {
} }
@ -322,8 +327,21 @@ namespace SourceMod
virtual unsigned int GetApiVersion() const { virtual unsigned int GetApiVersion() const {
return SMINTERFACE_PLUGINSYSTEM_VERSION; return SMINTERFACE_PLUGINSYSTEM_VERSION;
} }
// @brief Called when a plugin is about to be unloaded, before its
// OnPluginEnd callback is fired. This can be used to ensure that any
// asynchronous operations are flushed and no further operations can
// be started (via SetProperty).
//
// Like OnPluginUnloaded, this is only called for plugins which
// OnPluginLoaded was called.
virtual void OnPluginWillUnload(IPlugin *plugin)
{
}
}; };
static const unsigned int kMinPluginSysApiWithWillUnloadCallback = 8;
/** /**
* @brief Manages the runtime loading and unloading of plugins. * @brief Manages the runtime loading and unloading of plugins.
*/ */