bz eMessageFilteredEvent

From BZFlagWiki
Revision as of 07:49, 1 May 2014 by Allejo (Talk | contribs) (rawr, eventTime)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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).