bz saveWorldCacheFile

From BZFlagWiki
Revision as of 02:33, 14 August 2007 by JeffM2501 (Talk | contribs) (Parameters)

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

BZF_API bool bz_saveWorldCacheFile( const char* file );

Parameters

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

Description

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.