SetGameType: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function is for | 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. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setGameType ( string gameType ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''gameType:''' A string containing a name for the game mode | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if | Returns ''true'' if the game type was set, ''false'' if an invalid argument was passed to the function. | ||
==Example== | ==Example== | ||
This example | This example sets the game type to ''Capture The Flag''. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
setGameType ( "Capture The Flag" ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{All Seeing Eye functions}} | ||
Revision as of 10:54, 12 September 2006
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.
Syntax
bool setGameType ( string gameType )
Required Arguments
- gameType: A string containing a name for the game mode
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" )