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 ePlayerDieEvent: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 51: | Line 51: | ||
==Uses== | ==Uses== | ||
This event is a | This event is a modification event, for example killerID can be changed. | ||
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] | ||
Revision as of 02:43, 26 November 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
The bz_ePlayerDieEvent is an API event that is called each time a tank is killed.
Data
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 |
| time | double | Time of the event on the server. |
Uses
This event is a modification event, for example killerID can be changed.