|
|
| (2 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| | |
| ==Overview==
| |
| 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==
| |
| '''bz_eFilteredChatMessageEvent''' returns the '''bz_ChatEventData_V1''' data class, this class is shared with the [[bz_eRawChatMessageEvent]] event.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|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==
| |
| 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 longing or chat relay. Plug-ins that wish to do chat filtering should use the [[bz_eRawChatMessageEvent]] event.
| |