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

Difference between revisions of "Bz eServerMsgEvent"

From BZFlagWiki
Jump to: navigation, search
(Use {{BZFS_API_Doc}} {{BZFS_API_Events}})
m (typo)
Line 26: Line 26:
 
   |-
 
   |-
 
   |message
 
   |message
   |[[Bz_APIString|bzApiString]]
+
   |[[Bz_APIString|bz_ApiString]]
 
   |The message text
 
   |The message text
 
   |-
 
   |-

Revision as of 02:23, 23 December 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_eServerMsgEvent is an API event that is called each time the server sends a message.

Data

bz_eServerMsgEvent returns the bz_eServerMsgEvent_V1 data class.

name type value description
eventType bz_eEventType bz_eServerMsgEvent
to int ID of the player receiving the message
team bz_eTeamType The team/group receiving the message
message bz_ApiString The message text
time double Time local server time for the event.