This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eKickEvent"
From BZFlagWiki
Line 27: | Line 27: | ||
|reason | |reason | ||
|[[bz_ApiString]] | |[[bz_ApiString]] | ||
− | |The reason ( | + | |The reason (sent to kicked player). |
|- | |- | ||
|eventTime | |eventTime |
Revision as of 17:50, 8 May 2009
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_eKickEvent is an API event triggered when a player is kicked from the server.
Data
bz_eKickEvent returns the bz_KickEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eKickEvent |
kickerID | int | The ID of the player who performed the kick. |
kickedID | int | The ID of the player being kicked from the server. |
reason | bz_ApiString | The reason (sent to kicked player). |
eventTime | double | The server time the event occurred (in seconds.) |