bz ePlayerDieEvent

From BZFlagWiki
Revision as of 07:54, 1 May 2014 by Allejo (Talk | contribs) (time to eventTime)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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[edit]

The bz_ePlayerDieEvent is an API event that is called each time a tank is killed.

Data[edit]

bz_ePlayerDieEvent returns the bz_PlayerDieEventData_V1 data class.

name type value description
eventType bz_eEventType bz_ePlayerDieEvent
playerID int ID of the player who was killed.
team bz_eTeamType The team the killed player was on.
killerID int The owner of the shot that killed the player, or BZ_SERVER for server side kills ( world weapons, superkill, etc..)
killerTeam bz_eTeamType The team the owner of the shot was on.
flagKilledWith bz_ApiString The flag name the owner of the shot had when the shot was fired.
shotID int The shot ID that killed the player, if the player was not killed by a shot, the id will be -1.
state bz_PlayerUpdateState The state record for the killed player at the time of the event
eventTime double The server time at which the event occurred (in seconds).

Uses[edit]

This event is a modification event, for example killerID can be changed.