This wiki is archived and useful information is being migrated to the main bzflag.org website

bz eKillEvent

From BZFlagWiki
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_eKillEvent is an API event triggered when a player sends the /kill Slash Command to kill another player.

Data[edit]

bz_eKillEvent returns the bz_KillEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eKillEvent
killerID int The ID of the player who sent the /kill command
killedID int The ID of the player who was killed
reason bz_ApiString The reason (sent to killed player).
eventTime double The server time at which the event occurred (in seconds).