BZFlagWiki - User contributions [en]

Bz eHostBanNotifyEvent

2008-04-23T16:23:00Z

Catay: /* Overview */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eHostBanNotifyEvent''' is an API event that is called each time a
hostban is executed.

==Data==
'''bz_eHostBanNotifyEvent''' returns the '''bz_HostBanEventData_V1''' data
class.
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eHostBanNotifyEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]
|This value contains the reason why and by who a player got banned.
|-
|hostPattern
|[[bz_ApiString]]
|This value contains the host pattern that is banned.
|-
|eventTime
|double
|This value is the local server time of the event.
|}

==Uses==
This event is a notification only event, none of the data returned
can be changed.

Bz eHostBanModifyEvent

2008-04-23T16:21:53Z

Catay: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eHostBanModifyEvent''' is an API event that is called each time before a hostban is going to happen. ==Data== '''bz_eHostBanM...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eHostBanModifyEvent''' is an API event that is called each time
before a hostban is going to happen.

==Data==
'''bz_eHostBanModifyEvent''' returns the '''bz_HostBanEventData_V1''' data
class.
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eHostBanModifyEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]
|This value contains the reason why and by who a player got banned.
|-
|hostPattern
|[[bz_ApiString]]
|This value contains the host pattern that is banned.
|-
|eventTime
|double
|This value is the local server time of the event.
|}

==Uses==
This event is a modification event, all the members except evenTime can
be changed. In case bannerID is changed to a non-existant ID , the ban
will fail.

Bz eHostBanNotifyEvent

2008-04-23T16:17:27Z

Catay:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eHostBanNotifyEvent''' is an API event that is called each time a
regular ban is executed.

==Data==
'''bz_eHostBanNotifyEvent''' returns the '''bz_HostBanEventData_V1''' data
class.
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eHostBanNotifyEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]
|This value contains the reason why and by who a player got banned.
|-
|hostPattern
|[[bz_ApiString]]
|This value contains the host pattern that is banned.
|-
|eventTime
|double
|This value is the local server time of the event.
|}

==Uses==
This event is a notification only event, none of the data returned
can be changed.

Bz eHostBanEvent

2008-04-23T16:15:07Z

Catay: Bz eHostBanEvent moved to Bz eHostBanNotifyEvent: event name changed

#REDIRECT [[Bz eHostBanNotifyEvent]]

Bz eHostBanNotifyEvent

2008-04-23T16:15:07Z

Catay: Bz eHostBanEvent moved to Bz eHostBanNotifyEvent: event name changed

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eHostBanEvent''' is an API event that is called each time a
regular ban is executed.

==Data==
'''bz_eHostBanEvent''' returns the '''bz_HostBanEventData_V1''' data
class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eHostBanEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]
|This value contains the reason why and by who a player got banned.
|-
|hostPattern
|[[bz_ApiString]]
|This value contains the host pattern that is banned.
|-
|eventTime
|double
|This value is the local server time of the event.
|}

==Uses==
This event is a notification only event, none of the data returned
can be changed.

Events (API)

2008-04-23T16:10:43Z

Catay: /* Events */

{{DoDoc|Fill in articles for all API events}}

{{BZFS_API_Doc}}

==Overview==
API events are callbacks that a [[Plug-ins|plug-in]] can install into [[BZFS]] to be called in response to specific actions or state changes in the server side game world. Events are the primary method of communication from BZFS to installed plug-ins. Specific events exist for nearly all logical actions that can happen during a game of BZFlag.

==Installation and Removal==
The callbacks for events are typically installed during the [[bz_Load]] entry point in a plug-in, so they can be active when a plug-in is first loaded.

The plug-in must call the function;

BZF_API bool [[bz_registerEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

The plug-in registers and event callback derived from [[bz_EventHandler]] for each specific event types it wishes to monitor.

When a plug-in no longer needs to monitor an event, or when it is unloaded in the [[bz_Unload]] entry point, the plug-in must remove the installed callback by calling the function;

BZF_API bool [[bz_removeEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] and pass a pointer to an object of that class when ever it registers an event callback.

When ever a specific event is triggered, BZFS will call the 'process' method of the installed callback class.

virtual void process ( bz_EventData *eventData ) = 0;

==Event Data==
With each call to the 'process' method of the installed event handler, BZFS will pass the plug-in a pointer to a class that contains all the data provided by the event. Each event derives a specific data class from [[bz_EventData]] that contains the specific member variables that contain the data. The base class [[bz_EventData]] contains the data member;
bz_eEventType eventType;
This data member allows a plug-in to identify the specific event and cast the 'bz_EventData' pointer to the appropriate specific data class. This is usefull for plug-ins that use the same 'bz_EventHandler' to process more then one specific message.

Please see the descriptions of each specific event for information and descriptions of the data classes for each event. Some specific events allow plug-ins to change the values of data members in the data class and will use the modified values instead.

Plug-ins should never delete or free the memory for a data class. BZFS will manage all pointers passed to plug-ins.

==Events==
The following list contains all the event types currently supported by BZFS version 2.99

[[bz_eNullEvent]]
[[bz_eCaptureEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerSpawnEvent]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eAllowPlayer]]
[[bz_eTickEvent]]
[[bz_eGetWorldEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eAllowSpawn]]
[[bz_eListServerUpdateEvent]]
[[bz_eBanEvent]]
[[bz_eHostBanNotifyEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eIdBanEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameEndEvent]]
[[bz_eSlashCommandEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotFiredEvent]]
[[bz_eAnointRabbitEvent]]
[[bz_eNewRabbitEvent]]
[[bz_eReloadEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNetDataReceveEvent]]
[[bz_eLoggingEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eShotEndedEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_ePlayerCollision]]
[[bz_eFlagResetEvent]]
[[bz_eWorldFinalized]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eReportFiledEvent]]

There exists one additional event in the 'bz_eEventType' enumeration in 'bzfsAPI.h', ''bz_eLastEvent''. This event is simply used by BZFS to assist in the counting of the total number of events, it will never be called and can not be installed.

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Events]]

Functions (API)

2008-04-21T22:20:24Z

Catay: /* Server Administration */

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==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.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboText]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( 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_getFlagName]]( 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 );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPersistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int playerIndex, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IDBanUser]] ( int playerIndex, const char *bzID , int duration, const char *reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );

BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Bz eHostBanNotifyEvent

2008-04-20T00:31:52Z

Catay: /* Data */

Bz eHostBanNotifyEvent

2008-04-20T00:30:17Z

Catay: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eHostBanEvent''' is an API event that is called each time a regular ban is executed. ==Data== '''bz_eHostBanEvent''' returns t...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eHostBanEvent''' is an API event that is called each time a
regular ban is executed.

==Data==
'''bz_eHostBanEvent''' returns the '''bz_HostBanEventData_V1''' data
class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eHostBanEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]==Uses==
|This value contains the reason why and by who a player got banned.
|-
|hostPattern
|[[bz_ApiString]]
|This value contains the host pattern that is banned.
|-
|eventTime
|double==Uses==
|This value is the local server time of the event.
|}
==Uses==
This event is a notification only event, none of the data returned
can be changed.

Bz eIdBanEvent

2008-04-20T00:15:54Z

Catay: /* Data */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eIdBanEvent''' is an API event that is called each time a
ban on bzid (idban) is executed.

==Data==
'''bz_eIdBanEvent''' returns the '''bz_IdBanEventData_V1''' data
class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eIdBanEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|banneeID
|int
|This value is the player ID for the bannee.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]
|This value contains the reason why and by who a player got banned.
|-
|bzId
|[[bz_ApiString]]
|This value contains the BZFlag unique player identifier aka the bzid.
|-
|eventTime
|double
|This value is the local server time of the event.
|}
==Uses==
This event is a notification only event, none of the data returned
can be changed.

Bz eBanEvent

2008-04-20T00:14:38Z

Catay: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eBanEvent''' is an API event that is called each time a regular ban is executed. ==Data== '''bz_eBanEvent''' returns the '''bz...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eBanEvent''' is an API event that is called each time a
regular ban is executed.

==Data==
'''bz_eBanEvent''' returns the '''bz_BanEventData_V1''' data
class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eBanEvent
|-
|bannerID
|int
|This value is the player ID for the banner.
|-
|banneeID
|int
|This value is the player ID for the bannee.
|-
|duration
|int
|This value is the duration of the ban in minutes.
|-
|reason
|[[bz_ApiString]]
|This value contains the reason why and by who a player got banned.
|-
|ipAddress
|[[bz_ApiString]]
|This value contains the ipaddress of the bannee.
|-
|eventTime
|double
|This value is the local server time of the event.
|}
==Uses==
This event is a notification only event, none of the data returned
can be changed.

Bz eIdBanEvent

2008-04-20T00:04:02Z

Catay: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eIdBanEvent''' is an API event that is called each time a ban on bzid (idban) is executed. ==Data== '''bz_eIdBanEvent''' retur...

Events (API)

2008-04-19T23:33:50Z

Catay: /* Events */

{{DoDoc|Fill in articles for all API events}}

{{BZFS_API_Doc}}

==Overview==
API events are callbacks that a [[Plug-ins|plug-in]] can install into [[BZFS]] to be called in response to specific actions or state changes in the server side game world. Events are the primary method of communication from BZFS to installed plug-ins. Specific events exist for nearly all logical actions that can happen during a game of BZFlag.

==Installation and Removal==
The callbacks for events are typically installed during the [[bz_Load]] entry point in a plug-in, so they can be active when a plug-in is first loaded.

The plug-in must call the function;

BZF_API bool [[bz_registerEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

The plug-in registers and event callback derived from [[bz_EventHandler]] for each specific event types it wishes to monitor.

When a plug-in no longer needs to monitor an event, or when it is unloaded in the [[bz_Unload]] entry point, the plug-in must remove the installed callback by calling the function;

BZF_API bool [[bz_removeEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] and pass a pointer to an object of that class when ever it registers an event callback.

When ever a specific event is triggered, BZFS will call the 'process' method of the installed callback class.

virtual void process ( bz_EventData *eventData ) = 0;

==Event Data==
With each call to the 'process' method of the installed event handler, BZFS will pass the plug-in a pointer to a class that contains all the data provided by the event. Each event derives a specific data class from [[bz_EventData]] that contains the specific member variables that contain the data. The base class [[bz_EventData]] contains the data member;
bz_eEventType eventType;
This data member allows a plug-in to identify the specific event and cast the 'bz_EventData' pointer to the appropriate specific data class. This is usefull for plug-ins that use the same 'bz_EventHandler' to process more then one specific message.

Please see the descriptions of each specific event for information and descriptions of the data classes for each event. Some specific events allow plug-ins to change the values of data members in the data class and will use the modified values instead.

Plug-ins should never delete or free the memory for a data class. BZFS will manage all pointers passed to plug-ins.

==Events==
The following list contains all the event types currently supported by BZFS version 2.99

[[bz_eNullEvent]]
[[bz_eCaptureEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerSpawnEvent]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eAllowPlayer]]
[[bz_eTickEvent]]
[[bz_eGetWorldEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eAllowSpawn]]
[[bz_eListServerUpdateEvent]]
[[bz_eBanEvent]]
[[bz_eHostBanEvent]]
[[bz_eIdBanEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameEndEvent]]
[[bz_eSlashCommandEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotFiredEvent]]
[[bz_eAnointRabbitEvent]]
[[bz_eNewRabbitEvent]]
[[bz_eReloadEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNetDataReceveEvent]]
[[bz_eLoggingEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eShotEndedEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_ePlayerCollision]]
[[bz_eFlagResetEvent]]
[[bz_eWorldFinalized]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eReportFiledEvent]]

There exists one additional event in the 'bz_eEventType' enumeration in 'bzfsAPI.h', ''bz_eLastEvent''. This event is simply used by BZFS to assist in the counting of the total number of events, it will never be called and can not be installed.

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Events]]

Functions (API)

2008-04-07T21:00:48Z

Catay: /* Global Database Management (BZDB) */

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==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.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboText]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( 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_getFlagName]]( 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 );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPersistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int playerIndex, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

====Map Definition====
BZF_API bool [[bz_addWorldBox]] ( float *pos, float rot, float* scale, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldPyramid]] ( float *pos, float rot, float* scale, bool fliped, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldBase]]( float *pos, float rot, float* scale, bz_eTeamType team, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldTeleporter]] ( float *pos, float rot, float* scale, float border, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldWaterLevel]]( float level, [[bz_MaterialInfo]] *material );
BZF_API bool [[bz_addWorldWeapon]]( const char* flagType, float *pos, float rot, float tilt, float initDelay, [[bz_APIFloatList]] &delays );
BZF_API bool [[bz_setWorldSize]]( float size, float wallHeight = -1.0 );

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Functions (API)

2008-04-07T20:59:44Z

Catay: /* Chat Messages */

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==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.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboText]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( 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_getFlagName]]( 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 );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPesistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int playerIndex, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

====Map Definition====
BZF_API bool [[bz_addWorldBox]] ( float *pos, float rot, float* scale, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldPyramid]] ( float *pos, float rot, float* scale, bool fliped, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldBase]]( float *pos, float rot, float* scale, bz_eTeamType team, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldTeleporter]] ( float *pos, float rot, float* scale, float border, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldWaterLevel]]( float level, [[bz_MaterialInfo]] *material );
BZF_API bool [[bz_addWorldWeapon]]( const char* flagType, float *pos, float rot, float tilt, float initDelay, [[bz_APIFloatList]] &delays );
BZF_API bool [[bz_setWorldSize]]( float size, float wallHeight = -1.0 );

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Functions (API)

2008-04-07T20:55:18Z

Catay:

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==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.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboText]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sentFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( 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_getFlagName]]( 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 );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPesistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int playerIndex, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

====Map Definition====
BZF_API bool [[bz_addWorldBox]] ( float *pos, float rot, float* scale, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldPyramid]] ( float *pos, float rot, float* scale, bool fliped, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldBase]]( float *pos, float rot, float* scale, bz_eTeamType team, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldTeleporter]] ( float *pos, float rot, float* scale, float border, [[bz_WorldObjectOptions]] options );
BZF_API bool [[bz_addWorldWaterLevel]]( float level, [[bz_MaterialInfo]] *material );
BZF_API bool [[bz_addWorldWeapon]]( const char* flagType, float *pos, float rot, float tilt, float initDelay, [[bz_APIFloatList]] &delays );
BZF_API bool [[bz_setWorldSize]]( float size, float wallHeight = -1.0 );

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Bool bz fileReport

2008-04-07T20:49:52Z

Catay: New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz fileReport ( const char* message ); ==Parameters== {| border="1" cellpadding="20" cellspacing="0" !name !type !value...

{{BZFS_API_Doc}}
{{BZFS_API_Funcs}}
==Prototype==
BZF_API bool bz fileReport ( const char* message );
==Parameters==
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|message
|const char*
|The report message of the report going to be filed.
|}

==Description==
This API function will file a report message to the report
channel.

Bz eReportFiledEvent

2008-04-07T20:21:04Z

Catay: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eReportFiledEvent''' is an API event that is called each time a player or plugin files a report. ==Data== '''bz_eReportFiledEv...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eReportFiledEvent''' is an API event that is called each time a
player or plugin files a report.

==Data==
'''bz_eReportFiledEvent''' returns the
'''bz_ReportFiledEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eReportFiledEvent
|-
|playerID
|int
|The player ID that is filing the report.
|-
|message
|[[bz_ApiString]]
|The report message that is filed.
|-
|eventTime
|double
|Time of event.
|}

==Uses==
This event is a notification only event, none of the data returned can
be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Events (API)

2008-04-07T19:57:58Z

Catay: /* Events */

{{DoDoc|Fill in articles for all API events}}

{{BZFS_API_Doc}}

==Overview==
API events are callbacks that a [[Plug-ins|plug-in]] can install into [[BZFS]] to be called in response to specific actions or state changes in the server side game world. Events are the primary method of communication from BZFS to installed plug-ins. Specific events exist for nearly all logical actions that can happen during a game of BZFlag.

==Installation and Removal==
The callbacks for events are typically installed during the [[bz_Load]] entry point in a plug-in, so they can be active when a plug-in is first loaded.

The plug-in must call the function;

BZF_API bool [[bz_registerEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

The plug-in registers and event callback derived from [[bz_EventHandler]] for each specific event types it wishes to monitor.

When a plug-in no longer needs to monitor an event, or when it is unloaded in the [[bz_Unload]] entry point, the plug-in must remove the installed callback by calling the function;

BZF_API bool [[bz_removeEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] and pass a pointer to an object of that class when ever it registers an event callback.

When ever a specific event is triggered, BZFS will call the 'process' method of the installed callback class.

virtual void process ( bz_EventData *eventData ) = 0;

==Event Data==
With each call to the 'process' method of the installed event handler, BZFS will pass the plug-in a pointer to a class that contains all the data provided by the event. Each event derives a specific data class from [[bz_EventData]] that contains the specific member variables that contain the data. The base class [[bz_EventData]] contains the data member;
bz_eEventType eventType;
This data member allows a plug-in to identify the specific event and cast the 'bz_EventData' pointer to the appropriate specific data class. This is usefull for plug-ins that use the same 'bz_EventHandler' to process more then one specific message.

Please see the descriptions of each specific event for information and descriptions of the data classes for each event. Some specific events allow plug-ins to change the values of data members in the data class and will use the modified values instead.

Plug-ins should never delete or free the memory for a data class. BZFS will manage all pointers passed to plug-ins.

==Events==
The following list contains all the event types currently supported by BZFS version 2.99

[[bz_eNullEvent]]
[[bz_eCaptureEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerSpawnEvent]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eAllowPlayer]]
[[bz_eTickEvent]]
[[bz_eGetWorldEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eAllowSpawn]]
[[bz_eListServerUpdateEvent]]
[[bz_eBanEvent]]
[[bz_eHostBanEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameEndEvent]]
[[bz_eSlashCommandEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotFiredEvent]]
[[bz_eAnointRabbitEvent]]
[[bz_eNewRabbitEvent]]
[[bz_eReloadEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNetDataReceveEvent]]
[[bz_eLoggingEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eShotEndedEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_ePlayerCollision]]
[[bz_eFlagResetEvent]]
[[bz_eWorldFinalized]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eReportFiledEvent]]

There exists one additional event in the 'bz_eEventType' enumeration in 'bzfsAPI.h', ''bz_eLastEvent''. This event is simply used by BZFS to assist in the counting of the total number of events, it will never be called and can not be installed.

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Events]]