This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz eReportFiledEvent"

From BZFlagWiki
Jump to: navigation, search
(New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eReportFiledEvent''' is an API event that is called each time a player or plugin files a report. ==Data== '''bz_eReportFiledEv...)
 
(Uses: hyphenated compound adjective)
Line 33: Line 33:
  
 
==Uses==
 
==Uses==
This event is a notification only event, none of the data returned can
+
This event is a notification-only event, none of the data returned can
 
be changed.
 
be changed.
  
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Events]]
 
[[Category:BZFS_API_Events]]

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

The bz_eReportFiledEvent is an API event that is called each time a player or plugin files a report.

Data

bz_eReportFiledEvent returns the bz_ReportFiledEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eReportFiledEvent
playerID int The player ID that is filing the report.
message bz_ApiString The report message that is filed.
eventTime double Time of event.

Uses

This event is a notification-only event, none of the data returned can be changed.