|
|
| (126 intermediate revisions by 21 users not shown) |
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[BZFS API Functions]] |
| | |
| | |
| ==Overview==
| |
| | |
| 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.
| |
| | |
| ==Function Groups==
| |
| Functions are broken into a series of groups based on the type of action or information they deal with.
| |
| | |
| === Team Information Functions ===
| |
| BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
| |
| | |
| === Server Management ===
| |
| BZF_API bool [[bz_restart]] ( void );
| |
| | |
| === Map Management ===
| |
| BZF_API void [[bz_setClientWorldDowloadURL]]( const char* URL );
| |
| BZF_API const bzApiString [[bz_getClientWorldDowloadURL]] ( void );
| |
| BZF_API bool [[bz_saveWorldCacheFile]]( const char* file );
| |
| | |
| === Flag Management ===
| |
| | |
| BZF_API bool [[bz_givePlayerFlag]] ( int playerID, const char* flagType, bool force );
| |
| BZF_API bool [[bz_removePlayerFlag]] ( int playerID );
| |
| BZF_API void [[bz_resetFlags]] ( bool onlyUnused );
| |
| BZF_API unsigned int [[bz_getNumFlags]] ( void );
| |
| BZF_API const [[bz_ApiString]] bz_getName( int flag );
| |
| BZF_API bool [[bz_resetFlag]] ( int flag );
| |
| BZF_API int [[bz_flagPlayer]] ( int flag );
| |
| BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
| |
| BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3], bool reset = true );
| |
| | |
| === Shot Type Control ===
| |
| BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );
| |
| | |
| ===Misc===
| |
| | |
| ==See also==
| |
| [[BZFS API]] | |
| | |
| [[plug-ins]]
| |
| | |
| [[Category:BZFS_API_Functions]]
| |