This wiki is archived and useful information is being migrated to the main bzflag.org website

bz saveWorldCacheFile

From BZFlagWiki
Jump to: navigation, search
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[edit]

BZF_API bool bz_saveWorldCacheFile( const char* file );

Parameters[edit]

name type value desription
file const char* path and file name to save the cache file to

Description[edit]

Forces the server to save out a world cache file into the specified file. The function will return true if the write was sucsessfull, or false if there was an error.