|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==Overview==
| |
| The '''bz_eBanEvent''' is an API event that is called each time a
| |
| regular ban is executed.
| |
| | |
| ==Data==
| |
| '''bz_eBanEvent''' returns the '''bz_BanEventData_V1''' data
| |
| class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eBanEvent
| |
| |-
| |
| |bannerID
| |
| |int
| |
| |This value is the player ID for the banner.
| |
| |-
| |
| |banneeID
| |
| |int
| |
| |This value is the player ID for the bannee.
| |
| |-
| |
| |duration
| |
| |int
| |
| |This value is the duration of the ban in minutes.
| |
| |-
| |
| |reason
| |
| |[[bz_ApiString]]
| |
| |This value contains the reason why and by who a player got banned.
| |
| |-
| |
| |ipAddress
| |
| |[[bz_ApiString]]
| |
| |This value contains the ipaddress of the bannee.
| |
| |-
| |
| |eventTime
| |
| |double
| |
| |This value is the local server time of the event.
| |
| |}
| |
| ==Uses==
| |
| This event is a notification-only event, none of the data returned
| |
| can be changed.
| |