This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
Bz eMessageFilteredEvent: Difference between revisions
Jump to navigation
Jump to search
Strakowski (talk | contribs) Started page. No "Uses" or "History" sections. |
rawr, eventTime |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
The '''bz_eMessageFilteredEvent''' is an API event that is called whenever a message is | The '''bz_eMessageFilteredEvent''' is an API event that is called whenever a message is censored by the swear filter. | ||
==Data== | ==Data== | ||
| Line 23: | Line 23: | ||
|rawMessage | |rawMessage | ||
|[[bz_ApiString]] | |[[bz_ApiString]] | ||
|The text of the | |The unfiltered text of the message | ||
|- | |- | ||
|filteredMessage | |filteredMessage | ||
|[[bz_ApiString]] | |[[bz_ApiString]] | ||
|The text of the | |The text of the message after passing through the filter | ||
|- | |- | ||
| | |eventTime | ||
|double | |double | ||
|The | |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
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.
| 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). |