bz eServerMsgEvent

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
eventTime	double	The server time at which the event occurred (in seconds).