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

bz eServerMsgEvent

From BZFlagWiki
Revision as of 00:48, 25 September 2010 by Mrapple (Talk | contribs) (Use {{BZFS_API_Doc}} {{BZFS_API_Events}})

Jump to: navigation, search
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 bzApiString The message text
time double Time local server time for the event.