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 saveWorldCacheFile: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_saveWorldCacheFile( const char* file ); ==Parameters== * file ( path and file name to save the cache file to) ==Descri...
 
Line 5: Line 5:


==Parameters==
==Parameters==
 
{| border="1" cellpadding="20" cellspacing="0"
* file ( path and file name to save the cache file to)
  !name
  !type
  !value desription
  |-
  |file
  |const char*
  |path and file name to save the cache file to
  |}


==Description==
==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.
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.

Revision as of 02:33, 14 August 2007

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.