This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz zapPlayer"
From BZFlagWiki
(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...) |
m (Typo, player -> playing) |
||
| Line 11: | Line 11: | ||
==Description== | ==Description== | ||
| − | This function is used to force a player to respawn. Her client will simply respawn and continue | + | 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 | ||
Revision as of 23:41, 30 December 2008
| 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 not 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
