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 setClientWorldDownloadURL

From BZFlagWiki
Jump to navigation Jump to 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 void bz_setClientWorldDownloadURL( const char* URL );

Parameters

name type value desription
URL const char* a pointer to a string to the URL to be sent to connecting clients for the cached map

Description

This function sets the current URL used to download a cached world file. It will be sent to clients that connect giving them the option of using that file. This is helpful if the plug-ins have changed the map file during a a call to bz_restart.