This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

bz ePlayerJoinEvent

From BZFlagWiki
Revision as of 21:58, 27 November 2007 by JeffM2501 (talk | contribs) (Data)
Jump to navigation Jump to 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_ePlayerJoinEvent is an API event that is called each time a player joins the game.

Data

bz_ePlayerJoinEvent returns the bz_PlayerJoinPartEventData_V1 data class.

name type value desription
eventType bz_eEventType bz_eFlagDroppedEvent
playerID int The player that dropped the flag
record bz_BasePlayerRecord * The player record for the joining player
reason bzApiString Not used for join events
eventTime double Time of event.

Uses

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