This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

Bz zapPlayer: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
New page: {{BZFS_API_Doc}}{{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_zapPlayer(int player ); ==Parameters== ; int player : Player index to force a respawn. ==Returns== False if the player d...
 
Yassen (talk | contribs)
m Returns: Oops, this isn't BBCode
 
(2 intermediate revisions by the same user not shown)
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.


==Description==
==Description==
This function is used to force a player to respawn. Her client will simply respawn and continue player. 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.
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==
==Version==
Requires BZFS 2.99.5 (20080809, r18308) or later
Requires BZFS 2.99.5 (20080809, r18308) or later

Latest revision as of 23:40, 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.
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