This wiki is archived and useful information is being migrated to the main bzflag.org website
Editing BZFS API
Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.
The administrator who locked it offered this explanation: Archived wiki
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 26: | Line 26: | ||
BZF_PLUGIN_CALL int [[bz_Unload]] ( void ); | BZF_PLUGIN_CALL int [[bz_Unload]] ( void ); | ||
BZF_PLUGIN_CALL int [[bz_GetVersion]] ( void ); | BZF_PLUGIN_CALL int [[bz_GetVersion]] ( void ); | ||
− | |||
− | |||
[[bz_Load]] is called when the plug-in is first initialized. This is when the plug-in should register any [[Event(API)|event handlers]] needed and initialize any "one time" startup data. | [[bz_Load]] is called when the plug-in is first initialized. This is when the plug-in should register any [[Event(API)|event handlers]] needed and initialize any "one time" startup data. | ||
Line 39: | Line 37: | ||
BZ_GET_PLUGIN_VERSION | BZ_GET_PLUGIN_VERSION | ||
− | somewhere in its sources, and then export the function. This will automatically return the API version | + | somewhere in its sources, and then export the function. This will automatically return the API version of the current API you are using. See the sample plug-ins for examples. These will be the only 3 functions called by bzfs for non-event actions. |
− | + | All entry point functions should be preceded with the BZF_PLUGIN_CALL macro. This macro will tell your compiler to export these functions so bzfs can call them after the plug-in is loaded. | |
==Types== | ==Types== |