|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==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_commands|Slash Command]],another plug-in, or the game's core logic..
| |
| | |
| ==Data==
| |
| '''bz_eKickEvent''' returns the '''bz_KickEventData_V1''' data class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|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.)
| |
| |}
| |
| | |
| ==Uses==
| |
| | |
| | |
| [[Category:BZFS_API_Docs]] | |
| [[Category:BZFS_API_Events]]
| |