Difference between revisions of "Bz ePlayerCollision"

From BZFlagWiki
Jump to: navigation, search
(bz_ePlayerCollision)
 
(Data)
 
Line 5: Line 5:
 
The '''bz_ePlayerCollision''' is an API event that is called each time two players collide.
 
The '''bz_ePlayerCollision''' is an API event that is called each time two players collide.
 
==Data==
 
==Data==
'''bz_ePlayerCollision''' returns the '''bz_ePlayerCollision_V1''' data class.
+
'''bz_ePlayerCollision''' returns the '''bz_PlayerCollisionEventData_V1''' data class.
  
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
Line 28: Line 28:
 
   |Whether or not the plug-in has handled the data
 
   |Whether or not the plug-in has handled the data
 
   |}
 
   |}
 +
 
==Usage==
 
==Usage==
 
It appears this event is in BZFlag 2.99.x but has not been fully implemented and will probably never return data.
 
It appears this event is in BZFlag 2.99.x but has not been fully implemented and will probably never return data.

Latest revision as of 22:47, 26 September 2010

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[edit]

The bz_ePlayerCollision is an API event that is called each time two players collide.

Data[edit]

bz_ePlayerCollision returns the bz_PlayerCollisionEventData_V1 data class.

name type value description
eventType bz_eEventType bz_ePlayerCollision
players int[2] The players that have collided
pos float[3] The position of the collision
handled bool Whether or not the plug-in has handled the data

Usage[edit]

It appears this event is in BZFlag 2.99.x but has not been fully implemented and will probably never return data.