This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz loadPlugin"
From BZFlagWiki
(Update to modern template. Include Example.) |
m (Meant to use eWorldFinalized event. The eGameStartEvent isn't ready for loading plugins just yet.) |
||
Line 14: | Line 14: | ||
===Example=== | ===Example=== | ||
Attempt to load the '''FlagOnSpawn''' plugin with the parameters to give any team a WG flag on spawn when the game starts. | Attempt to load the '''FlagOnSpawn''' plugin with the parameters to give any team a WG flag on spawn when the game starts. | ||
− | case | + | case bz_eWorldFinalized: { |
bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1"); | bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1"); | ||
}break; | }break; |
Revision as of 10:23, 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. 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_eWorldFinalized: { bz_loadPlugin("/home/name/path/to/flagOnSpawn.so","WG:-1"); }break;