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 eFlagDroppedEvent: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
No edit summary
Line 9: Line 9:
This class contains the following data members
This class contains the following data members


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


==Uses==
==Uses==

Revision as of 02:25, 14 August 2007

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