bz ePlayerPauseRequestEvent

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_ePlayerPauseRequestEvent is an API event that is called each time a player wants to pause.

Data

bz_ePlayerPauseRequestEvent returns the bz_PlayerPauseRequestData_V1 data class.

name	type	value description
eventType	bz_eEventType	bz_ePlayerPauseRequestEvent
playerID	int	ID of the player who wants to pause
allow	bool	Wether or not to allow the pause
reason	bz_APIString	The reason if pause request is denied. Default: pause request denied

Usage

Data retured can be modified.