This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
Bz loadPlugin: Difference between revisions
		
		
		
		Jump to navigation
		Jump to search
		
 New page: {{BZFS_API_Doc}}{{BZFS_API_Funcs}} ==Syntax== bool bz_loadPlugin( const char* path, const char* params )  ==Parameters== * '''''path''''': The path to the plug-in to load.  * '''''params''...  | 
				m Don't know for sure.  | 
				||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{  | {{apicall  | ||
==  | | name          = bz_loadPlugin  | ||
| returns       = Whether or not the plugin was loaded successfully.  | |||
| returntype    = bool  | |||
| description   = Attempts to load a plugin with the given path and filename along with any passed parameters.  | |||
| param1      = path  | |||
| param1type  = const char*  | |||
| param1desc  = The exact path to the file.  | |||
| param2      = params  | |||
| param2type  = const char*  | |||
| param2desc  = The command separated list of file parameters to pass on to the plugin.  | |||
}}  | |||
==  | ===Example===  | ||
Attempt to load the '''FlagOnSpawn''' plugin with the parameters to give any team a WG flag on spawn when the game starts.  | |||
 case bz_eWorldFinalized: {  | |||
 	bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1");  | |||
 }break;  | |||
Latest revision as of 10:32, 19 October 2011
bool bz_loadPlugin (const char* path, const char* params)
Attempts to load a plugin with the given path and filename along with any passed parameters.
Parameters: 
path  -  The exact path to the file. 
params  -  The command separated list of file parameters to pass on to the plugin. 
Returns: 
Whether or not the plugin was loaded successfully.
Example
Attempt to load the FlagOnSpawn plugin with the parameters to give any team a WG flag on spawn when the game starts.
case bz_eWorldFinalized: {
	bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1");
}break;