This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz setClientWorldDownloadURL"
From BZFlagWiki
(New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API void bz_setClientWorldDowloadURL( const char* URL ); ==Parameters== * URL ( a pointer to a string to the URL to be sent to conn...) |
m (correct func name) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
{{BZFS_API_Funcs}} | {{BZFS_API_Funcs}} | ||
==Prototype== | ==Prototype== | ||
− | BZF_API void | + | BZF_API void bz_setClientWorldDownloadURL( const char* URL ); |
==Parameters== | ==Parameters== | ||
− | + | {| border="1" cellpadding="20" cellspacing="0" | |
− | + | !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== | ==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 [[ | + | 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]]. |
Latest revision as of 20:14, 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[edit]
BZF_API void bz_setClientWorldDownloadURL( const char* URL );
Parameters[edit]
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[edit]
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.