BZFlagWiki - User contributions [en]

Bz eMessageFilteredEvent

2009-10-06T02:54:10Z

Strakowski: Changed wording slightly. Sounds bettter now.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eMessageFilteredEvent''' is an API event that is called whenever a message is censored by the swear filter.

==Data==
'''bz_eMessageFilteredEvent''' returns the '''bz_MessageFilteredEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eMessageFilteredEvent
|-
|player
|int
|The player who sent the filtered message
|-
|rawMessage
|[[bz_ApiString]]
|The unfiltered text of the message
|-
|filteredMessage
|[[bz_ApiString]]
|The text of the message after passing through the filter
|-
|time
|double
|The local server time at which the message was sent
|}

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

Bz eMessageFilteredEvent

2009-10-06T02:52:36Z

Strakowski: Started page. No "Uses" or "History" sections.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eMessageFilteredEvent''' is an API event that is called whenever a message is filtered by the swear filter.

==Data==
'''bz_eMessageFilteredEvent''' returns the '''bz_MessageFilteredEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eMessageFilteredEvent
|-
|player
|int
|The player who sent the filtered message
|-
|rawMessage
|[[bz_ApiString]]
|The text of the sent message without any filtration
|-
|filteredMessage
|[[bz_ApiString]]
|The text of the sent message after filtration
|-
|time
|double
|The local server time at which the message was sent
|}

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

Events (API)

2009-10-06T02:35:23Z

Strakowski: Corrected "bz_eLoggingEvent" to "bz_eLoginEvent"

{{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_eGameStartEvent|bz_eGameEndEvent]]
[[bz_eSlashCommandEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotFiredEvent]]
[[bz_eAnointRabbitEvent]]
[[bz_eNewRabbitEvent]]
[[bz_eReloadEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNetDataReceveEvent]]
[[bz_eLogingEvent]]
[[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]]
[[bz_eTeleportEvent]]

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]]

Bz ePlayerAuthEvent

2009-10-06T02:20:44Z

Strakowski: Started page. No "Uses" or "History" sections yet.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerAuthEvent''' is an API event triggered when a player's authorization status changes.

==Data==
'''bz_ePlayerAuthEvent''' returns the '''bz_PlayerAuthEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerAuthEvent
|-
|playerID
|int
|The ID of the player who's authorization changed
|}

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

Bz eKillEvent

2009-10-06T02:14:22Z

Strakowski: Started page. No "Uses" or "History" sections yet.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eKillEvent''' is an API event triggered when a player sends the /kill [[Slash_commands|Slash Command]] to kill another player.

==Data==
'''bz_eKillEvent''' returns the '''bz_KillEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eKillEvent
|-
|killerID
|int
|The ID of the player who sent the /kill command
|-
|killedID
|int
|The ID of the player who was killed
|-
|reason
|[[bz_ApiString]]
|The reason (sent to killed player).
|}

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

Bz eFlagTransferredEvent

2009-10-05T19:05:47Z

Strakowski: Started page. Still very vague. Will revisit soon.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eFlagTransferredEvent''' is an API event that is called each time a player with Thief steals a flag.

==Data==
'''bz_eFlagTransferredEvent''' returns the '''bz_FlagTransferredEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eFlagTransferredEvent
|-
|fromPlayerID
|int
|The ID of the player that stole the flag
|-
|toPlayerID
|int
|The ID of the player whose flag was stolen
|-
|flagType
|const char*
|The flag code of the stolen flag
|-
|action
|enum Action
|The action taken for the transfer. Values: ContinueSteal, CancelSteal, DropThief
|}

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

Bz eSlashCommandEvent

2009-10-05T01:25:53Z

Strakowski: Started page. No "Uses" or "History" sections yet.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eSlashCommandEvent''' is an API event that is called each time a player sends a slash command.

==Data==
'''bz_eSlashCommandEvent''' returns the '''bz_SlashCommandEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eSlashCommandEvent
|-
|from
|int
|The player who sent the slash command
|-
|message
|bzApiString
|The full text of the chat message for the slash command, containing the command and all associated parameters
|-
|time
|double
|The local server time of the event
|}

Bz eFlagGrabbedEvent

2009-10-05T01:03:51Z

Strakowski: Started the page. Almost identical to flag dropped event. Page still needs history.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eFlagGrabbedEvent''' is an API event that is called each time a flag is grabbed by a player.

==Data==
'''bz_eFlagGrabbedEvent''' returns the '''bz_FlagGrabbedEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eFlagGrabbedEvent
|-
|playerID
|int
|The player that grabbed the flag
|-
|flagID
|int
|The flag ID that was grabbed
|-
|pos
|float[3]
|The position at which the flag was grabbed
|}

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

Bz eFlagDroppedEvent

2009-10-03T04:15:03Z

Strakowski: Fixed a sentence that ended with preposition.

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eFlagDroppedEvent''' is an API event that is called each time a flag is dropped by a player.

==Data==
'''bz_eFlagDroppedEvent''' returns the '''bz_FlagDroppedEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value desription
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eFlagDroppedEvent
|-
|playerID
|int
|The player that dropped the flag
|-
|flagID
|int
|The flag ID that was dropped
|-
|pos
|float[3]
|The position at which the flag was dropped
|}

==Uses==
This event is a notification only event, none of the data returned can be changed. If the plug-in wishes to change the spawning position of a flag it should use the [[bz_eFlagResetEvent]]

==History==
In Version 2.0.x of BZFlag the data class for this event was named '''bz_FlagDroppedEvenData''' and contains the same data.

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