BZFS API - Revision history

Zehra: merged content from BZFS API Events

2025-11-30T02:48:17Z

merged content from BZFS API Events

Show changes

Zehra: added API functions

2025-11-30T02:20:21Z

added API functions

Show changes

Loymdayddaud: Add note about information on main site

2025-11-02T04:39:58Z

Add note about information on main site

← Older revision		Revision as of 04:39, 2 November 2025
Line 2:		Line 2:
	Update to 2.4.x spec<br>		Update to 2.4.x spec<br>
	}}		}}

			==Note==
			The most up-to-date information about the BZFS API can be found here: https://www.bzflag.org/documentation/developer/bzfs_api/

	The BZFS API (Application Programmers Interface) is a set of C++ functions, structures, and classes that is exported by [[BZFS]] to be used by [[Plug-ins]]. The API provides access to the various states and data structures of a running BZFS game and is the primary method of communication between a plug-in and the game server.		The BZFS API (Application Programmers Interface) is a set of C++ functions, structures, and classes that is exported by [[BZFS]] to be used by [[Plug-ins]]. The API provides access to the various states and data structures of a running BZFS game and is the primary method of communication between a plug-in and the game server.

Alezakos: Update links to API events/functions documentation

2015-08-22T10:19:54Z

Update links to API events/functions documentation

← Older revision		Revision as of 10:19, 22 August 2015
Line 98:		Line 98:
	Plug-ins can register callbacks so they can be notified of various actions and state changes in the current BZFS game. These events tell a plug-in when important things happen, such as when a player has spawned, or is killed. These events are the primary form of communication from the BZFS server into the plug-in.		Plug-ins can register callbacks so they can be notified of various actions and state changes in the current BZFS game. These events tell a plug-in when important things happen, such as when a player has spawned, or is killed. These events are the primary form of communication from the BZFS server into the plug-in.

	{{main\|~~Event~~(API)}}		{{main\|Events (API)}}

	==Functions==		==Functions==
	The BZFS API provides a number of functions to plug-ins for use in querying the current game state. Functions are used both to get information about the game, and to trigger in game actions, such as activating a world weapon.		The BZFS API provides a number of functions to plug-ins for use in querying the current game state. Functions are used both to get information about the game, and to trigger in game actions, such as activating a world weapon.

	{{main\|Functions(API)}}		{{main\|Functions (API)}}

	==Wiki Documentation==		==Wiki Documentation==
Line 112:		Line 112:
	==See Also==		==See Also==

	* [[~~Event~~(API)\|API Events]]		* [[Events (API)\|API Events]]
	* [[Functions(API)\|API Functions]]		* [[Functions (API)\|API Functions]]
	* [[Plug-ins]]		* [[Plug-ins]]
	* [[BZFS]]		* [[BZFS]]

Allejo: Added todo doc

2014-01-08T08:50:12Z

Added todo doc

← Older revision		Revision as of 08:50, 8 January 2014
Line 1:		Line 1:
			{{DoDoc\|
			Update to 2.4.x spec<br>
			}}

	The BZFS API (Application Programmers Interface) is a set of C++ functions, structures, and classes that is exported by [[BZFS]] to be used by [[Plug-ins]]. The API provides access to the various states and data structures of a running BZFS game and is the primary method of communication between a plug-in and the game server.		The BZFS API (Application Programmers Interface) is a set of C++ functions, structures, and classes that is exported by [[BZFS]] to be used by [[Plug-ins]]. The API provides access to the various states and data structures of a running BZFS game and is the primary method of communication between a plug-in and the game server.

JeffM2501: /* Entry Points */ clarifications,order, etc..

2011-05-10T02:15:11Z

Entry Points: clarifications,order, etc..

← Older revision		Revision as of 02:15, 10 May 2011
Line 22:		Line 22:
	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 );

			All entry point functions must be preceded with the BZF_PLUGIN_CALL macro. This macro tells the compiler to export these functions so bzfs can find them when the plug-in is loaded.

	[[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 33:		Line 35:
	BZ_GET_PLUGIN_VERSION		BZ_GET_PLUGIN_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~~.		somewhere in its sources, and then export the function. This will automatically return the API version that the plug-in was compiled with.

	~~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~~.		See the sample plug-ins for examples of each function. These will be the only 3 functions called by bzfs that are not tied to events or other actions installed by the plug-in after load.

	==Types==		==Types==

JeffM2501: /* Naming Conventions */ mention that it's all V3

2011-05-10T02:12:29Z

Naming Conventions: mention that it's all V3

← Older revision		Revision as of 02:12, 10 May 2011
Line 8:		Line 8:
	==Naming Conventions==		==Naming Conventions==
	All BZFS API code structures will begin with the prefix '''bz''' or '''bz_''' for clarification and to prevent conflicts with names of code structures inside BZFS or any plug-ins.		All BZFS API code structures will begin with the prefix '''bz''' or '''bz_''' for clarification and to prevent conflicts with names of code structures inside BZFS or any plug-ins.

			All wiki documentation references the newer BZFS 3.0 API.

	==API Versions==		==API Versions==

JeffM2501: /* Wiki Documentation */ the english... she escapes me.

2011-05-10T02:05:16Z

Wiki Documentation: the english... she escapes me.

← Older revision		Revision as of 02:05, 10 May 2011
Line 100:		Line 100:
	The documentation for the API provided on this wiki is mostly concerned with the current development version of the software. There have been changes over time to the API. Any changes to classes and functions will be noted in the new documentation under a ''History'' section. In general the initial API that was released with the 2.0.x product line was not consistent, and many of these inconsistencies are being worked out with newer versions of the API (3.0 and later)		The documentation for the API provided on this wiki is mostly concerned with the current development version of the software. There have been changes over time to the API. Any changes to classes and functions will be noted in the new documentation under a ''History'' section. In general the initial API that was released with the 2.0.x product line was not consistent, and many of these inconsistencies are being worked out with newer versions of the API (3.0 and later)

	~~All~~ API developers should use the bzfsAPI.h file as ~~well~~ for exact spellings of methods and parameters.		API developers should use the bzfsAPI.h file as for exact spellings of methods and parameters in the version they wish to use.

	==See Also==		==See Also==

JeffM2501: /* API Versions */ Don't talk about the future like it is already here.

2011-05-10T02:03:25Z

API Versions: Don't talk about the future like it is already here.

← Older revision		Revision as of 02:03, 10 May 2011
Line 12:		Line 12:
	The API was added in version 2.0.4 of BZFlag. While working well for many users, it was found to be lacking in a number of features that would make make it difficult for plug-ins to run when the API itself was changed.		The API was added in version 2.0.4 of BZFlag. While working well for many users, it was found to be lacking in a number of features that would make make it difficult for plug-ins to run when the API itself was changed.

	In version 3.0 of BZFlag, the entire API will be versioned and set up to use derived classes so that plug-ins written to use an older version of the API will work in newer versions of the software. Newer data structures ~~would~~ be put into further derived classes and would not be seen by the older plug-in. Due to this change a large number of API functions changed in name. This change causes all older 2.0.x plug-ins to no longer work with out a source code ~~change~~. Once older plug-~~ins are~~ updated to the new 2.~~1 API they~~ will ~~use the new versioning system and~~ work ~~fine~~ in ~~newer~~ versions ~~with out any needed changes~~.		In version 3.0 of BZFlag, the entire API will be versioned and set up to use derived classes so that plug-ins written to use an older version of the API will work in newer versions of the software. Newer data structures will be put into further derived classes and would not be seen by the older plug-in. Due to this change a large number of API functions changed in name. This change causes all older 2.0.x plug-ins to no longer work with out minor source code changes. Once an older plug-in has been updated to the new API it will not work in 2.0.x but will work in all versions after 3.0.

	==Entry Points==		==Entry Points==

JeffM2501: /* API Versions */ Don't talk about the future like it is already here.

2011-05-10T02:01:36Z

API Versions: Don't talk about the future like it is already here.

← Older revision		Revision as of 02:01, 10 May 2011
Line 12:		Line 12:
	The API was added in version 2.0.4 of BZFlag. While working well for many users, it was found to be lacking in a number of features that would make make it difficult for plug-ins to run when the API itself was changed.		The API was added in version 2.0.4 of BZFlag. While working well for many users, it was found to be lacking in a number of features that would make make it difficult for plug-ins to run when the API itself was changed.

	~~As of~~ version 2.1 of BZFlag, the entire API ~~was~~ versioned and set up to use derived classes so that plug-ins written to use an older version of the API will work in newer versions of the software. Newer data structures would be put into further derived classes and would not be seen by the older plug-in. Due to this change a large number of API functions changed in name. This change causes all older 2.0.x plug-ins to no longer work with out a source code change. Once older plug-ins are updated to the new 2.1 API they will use the new versioning system and work fine in newer versions with out any needed changes.		In version 3.0 of BZFlag, the entire API will be versioned and set up to use derived classes so that plug-ins written to use an older version of the API will work in newer versions of the software. Newer data structures would be put into further derived classes and would not be seen by the older plug-in. Due to this change a large number of API functions changed in name. This change causes all older 2.0.x plug-ins to no longer work with out a source code change. Once older plug-ins are updated to the new 2.1 API they will use the new versioning system and work fine in newer versions with out any needed changes.

	==Entry Points==		==Entry Points==