Difference between revisions of "Bz eMessageFilteredEvent"

From BZFlagWiki
Jump to: navigation, search
m (Changed wording slightly. Sounds bettter now.)
(rawr, eventTime)
 
Line 29: Line 29:
 
   |The text of the message after passing through the filter
 
   |The text of the message after passing through the filter
 
   |-
 
   |-
   |time
+
   |eventTime
 
   |double
 
   |double
   |The local server time at which the message was sent
+
   |The server time at which the event occurred (in seconds).
 
   |}
 
   |}
  
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Events]]
 
[[Category:BZFS_API_Events]]

Latest revision as of 07:49, 1 May 2014

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.

BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.


Overview[edit]

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

Data[edit]

bz_eMessageFilteredEvent returns the bz_MessageFilteredEventData_V1 data class.

name type value description
eventType 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
eventTime double The server time at which the event occurred (in seconds).