bz_loadPlugin

From BZFlagWiki
Revision as of 10:18, 19 October 2011 by Sigonasr2 (Talk | contribs) (Update to modern template. Include Example.)

Jump to: navigation, search

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. In addition, it may be locally referenced starting from the path returned by bz_pluginBinPath().
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_eGameStartEvent: {
	bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1");
}break;