Difference between revisions of "Bz zapPlayer"

From BZFlagWiki
Jump to: navigation, search
m (Typo, player -> playing)
m (Returns: Shouldn't work if the player is alive, not the other way around)
Line 7: Line 7:
  
 
==Returns==
 
==Returns==
False if the player does not exist, or is not alive.
+
False if the player does not exist, or is alive.[br]
 
True if the operation completed.
 
True if the operation completed.
  

Revision as of 23:39, 5 May 2009

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.
BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call.

Prototype

BZF_API bool bz_zapPlayer(int player );

Parameters

int player 
Player index to force a respawn.

Returns

False if the player does not exist, or is alive.[br] True if the operation completed.

Description

This function is used to force a player to respawn. Her or his client will simply respawn and continue playing. Any flags will be dropped. Plug-ins that wish to move the player to a specific location must provide that position on the bz_eGetPlayerSpawnPosEvent event.

Version

Requires BZFS 2.99.5 (20080809, r18308) or later