This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz unloadPlugin"

From BZFlagWiki
Jump to: navigation, search
(Create API Function Page. Include Example.)
 
m (Don't know for sure.)
 
Line 6: Line 6:
 
| param1      = path
 
| param1      = path
 
| param1type  = const char*
 
| param1type  = const char*
| param1desc  = The exact path of the plugin file. In addition, it may be locally referenced starting from the path returned by bz_pluginBinPath().
+
| param1desc  = The exact path of the plugin file.
 
}}
 
}}
  

Latest revision as of 10:32, 19 October 2011

bool bz_unloadPlugin (const char* path)


Unloads a plugin that is currently loaded.

Parameters:
path  -  The exact path of the plugin file.
Returns:
Whether or not the plugin unloaded successfully.


Example[edit]

Load the FlagOnSpawn plugin which then gets unloaded the moment a player joins.

case bz_eWorldFinalized: {
	bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1");
}break;
case bz_ePlayerJoinEvent: {
	bz_unloadPlugin("/home/name/path/to/flagOnSpawn.so");
}break;