bz eHostBanNotifyEvent

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_eHostBanNotifyEvent is an API event that is called each time a hostban is executed.

Data[edit]

bz_eHostBanNotifyEvent returns the bz_HostBanEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eHostBanNotifyEvent
bannerID int This value is the player ID for the banner.
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.
hostPattern bz_ApiString This value contains the host pattern that is banned.
eventTime double This value is the local server time of the event.

Uses[edit]

This event is a notification-only event, none of the data returned can be changed.