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 eKickEvent: Difference between revisions
Jump to navigation
Jump to search
Added documentation for event. |
m clarification |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
The '''bz_eKickEvent''' is an API event triggered when a player is kicked from the server. | The '''bz_eKickEvent''' is an API event triggered when a player is kicked from the server. This event may be triggered by both the /kick [[Slash_commands|Slash Command]],another plug-in, or the game's core logic.. | ||
==Data== | ==Data== | ||
| Line 27: | Line 27: | ||
|reason | |reason | ||
|[[bz_ApiString]] | |[[bz_ApiString]] | ||
|The reason ( | |The reason (sent to kicked player). | ||
|- | |- | ||
|eventTime | |eventTime | ||
Latest revision as of 17:52, 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. This event may be triggered by both the /kick Slash Command,another plug-in, or the game's core logic..
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.) |