This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eFlagDroppedEvent"
From BZFlagWiki
(→Data) |
(→Uses) |
||
Line 32: | Line 32: | ||
==Uses== | ==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]] | 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]] | ||
+ | |||
+ | ==History== | ||
+ | In Version 2.0.x of BZFlag the data class for this event was named '''bz_FlagDroppedEvenData''' and contains the same data. | ||
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] |
Revision as of 02:47, 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.
Contents
Overview
The bz_eFlagDroppedEvent is an API event that is called each time a flag is drooped by a player.
Data
bz_eFlagDroppedEvent returns the bz_FlagDroppedEventData_V1 data class.
name | type | value desription |
---|---|---|
eventType | bz_eEventType | bz_eFlagDroppedEvent |
playerID | int | The player that dropped the flag |
flagID | int | The flag ID that was dropped |
pos | float[3] | the position 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
History
In Version 2.0.x of BZFlag the data class for this event was named bz_FlagDroppedEvenData and contains the same data.