This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz restart"
From BZFlagWiki
(→Description) |
m (grammar) |
||
(One intermediate revision by one other user not shown) | |||
Line 18: | Line 18: | ||
* accept new connections. | * accept new connections. | ||
− | ==Usage | + | ==Usage== |
− | This will basically do a server and map reload, | + | This will basically do a server and map reload, without a full shutdown of the server executable. None of the plug ins are unloaded and the server will not be delisted from the list server. This function is intended for plug-ins that wish to reload the server with a different map. |
==Notes== | ==Notes== | ||
There may be some additional things that need to reset. They will need to be added as they are found ( like reload the command line options, or let the plug-in set them ). | There may be some additional things that need to reset. They will need to be added as they are found ( like reload the command line options, or let the plug-in set them ). |
Latest revision as of 07:43, 3 December 2013
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. |
Contents
Prototype[edit]
BZF_API bool bz_restart ( void );
Parameters[edit]
none.
Description[edit]
This API function will cause the server to do a full restart. This restart will perform the following actions.
- kick all players
- stop any countdowns
- stop any recordings
- unload the world
- reload the world ( calling bz_eGetWorldEvent allowing for a map file override )
- resets all flags.
- accept new connections.
Usage[edit]
This will basically do a server and map reload, without a full shutdown of the server executable. None of the plug ins are unloaded and the server will not be delisted from the list server. This function is intended for plug-ins that wish to reload the server with a different map.
Notes[edit]
There may be some additional things that need to reset. They will need to be added as they are found ( like reload the command line options, or let the plug-in set them ).