This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eFilteredChatMessageEvent"
m |
(→Uses: hyphenated compound adjective) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 16: | Line 16: | ||
|eventType | |eventType | ||
|[[Event(API)|bz_eEventType]] | |[[Event(API)|bz_eEventType]] | ||
− | | | + | |bz_eFilteredChatMessageEvent. |
|- | |- | ||
|from | |from | ||
Line 32: | Line 32: | ||
|message | |message | ||
|[[bz_ApiString]] | |[[bz_ApiString]] | ||
− | |The | + | |The filtered final text of the message. |
|- | |- | ||
|eventTime | |eventTime | ||
Line 40: | Line 40: | ||
==Uses== | ==Uses== | ||
− | This is a notification only event. The text of the chat message can not be changed, and has been pre-filtered. This event is the primary hook for plug-ins that wish to implement chat | + | This is a notification-only event. The text of the chat message can not be changed, and has been pre-filtered. This event is the primary hook for plug-ins that wish to implement chat logging or chat relay. Plug-ins that wish to do chat filtering should use the [[bz_eRawChatMessageEvent]] event. |
Latest revision as of 23:30, 27 January 2013
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_eFilteredChatMessageEvent is an API event that is called for each chat message the server receives. It is called after the server or any plug-ins have done chat filtering.
Data[edit]
bz_eFilteredChatMessageEvent returns the bz_ChatEventData_V1 data class, this class is shared with the bz_eRawChatMessageEvent event.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eFilteredChatMessageEvent. |
from | int | The player ID sending the message. |
to | int | The player ID that the message is to if the message is to an individual, or a broadcast. If the message is a broadcast the id will be BZ_ALLUSERS. |
team | bz_eTeamType | The team the message is for if it not for an individual or a broadcast. If it is not a team message the team will be eNoTeam. |
message | bz_ApiString | The filtered final text of the message. |
eventTime | double | The time of the event. |
Uses[edit]
This is a notification-only event. The text of the chat message can not be changed, and has been pre-filtered. This event is the primary hook for plug-ins that wish to implement chat logging or chat relay. Plug-ins that wish to do chat filtering should use the bz_eRawChatMessageEvent event.