Difference between revisions of "Bz eReportFiledEvent"

From BZFlagWiki
Jump to: navigation, search
(Uses: hyphenated compound adjective)
(fix inaccurate property)
 
Line 19: Line 19:
 
   |bz_eReportFiledEvent
 
   |bz_eReportFiledEvent
 
   |-
 
   |-
   |playerID
+
   |from
   |int
+
   |[[bz_ApiString]]
   |The player ID that is filing the report.
+
   |The callsign of the player that is filing the report.
 
   |-
 
   |-
 
   |message
 
   |message

Latest revision as of 22:13, 4 November 2015

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_eReportFiledEvent is an API event that is called each time a player or plugin files a report.

Data[edit]

bz_eReportFiledEvent returns the bz_ReportFiledEventData_V1 data class.

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

Uses[edit]

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