SetGameType: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
{{Server function}} | {{Server function}} | ||
This function sets a string containing a name for the game type. This should be the game-mode that is active, for example "Capture The Flag" or "Deathmatch". This is then displayed in the server browser and external server browsers. | This function sets a string containing a name for the game type. This should be the game-mode that is active, for example "Capture The Flag" or "Deathmatch". This is then displayed in the server browser and external server browsers. | ||
'''It should be noted that [[mapmanager]] handles this automatically for gamemodes that utilise the map/gamemode system.''' | |||
==Syntax== | ==Syntax== | ||
Revision as of 16:23, 30 January 2009
This function sets a string containing a name for the game type. This should be the game-mode that is active, for example "Capture The Flag" or "Deathmatch". This is then displayed in the server browser and external server browsers.
It should be noted that mapmanager handles this automatically for gamemodes that utilise the map/gamemode system.
Syntax
bool setGameType ( string gameType )
Required Arguments
- gameType: A string containing a name for the game mode, or false to clear it.
Returns
Returns true if the game type was set, false if an invalid argument was passed to the function.
Example
This example sets the game type to Capture The Flag.
setGameType ( "Capture The Flag" )
See Also