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

bz eFlagDroppedEvent

From BZFlagWiki
Revision as of 02:26, 14 August 2007 by JeffM2501 (Talk | contribs) (Overview)

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_eFlagDroppedEvent is an API event that is called each time a flag is drooped by a player.

Data

As of version 2.1 of BZFS the event callback will contain the bz_FlagDroppedEventData_V1 data class. This class contains the following data members

  • eventType ( always bz eFlagDroppedEvent )
  • playerID ( the player that dropped the flag )
  • flagID ( the flag ID that was dropped )
  • pos[3] ( the postion the flag was dropped at )

Uses

This event is a notification only event, none of the data returned can be changed. If the plug-in wishes to change the spawning position of a flag it should use the bz_eFlagResetEvent