Difference between revisions of "Bz setClientWorldDownloadURL"

From BZFlagWiki
Jump to: navigation, search
m (spelling)
Line 2: Line 2:
 
{{BZFS_API_Funcs}}
 
{{BZFS_API_Funcs}}
 
==Prototype==
 
==Prototype==
BZF_API void bz_setClientWorldDowloadURL( const char* URL );
+
BZF_API void bz_setClientWorldDownloadURL( const char* URL );
  
 
==Parameters==
 
==Parameters==

Revision as of 20:13, 25 September 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 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_reload.