SetGameType: Difference between revisions
Jump to navigation
Jump to search
^iiEcoo'x ) (talk | contribs) No edit summary |
Fernando187 (talk | contribs) m (add MAX 200 characters according to ASE.h constants) |
||
(One intermediate revision by one other user not shown) | |||
Line 9: | Line 9: | ||
bool setGameType ( string gameType ) | bool setGameType ( string gameType ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[File:GameType.png|thumb| | [[File:GameType.png|thumb|Gamemode column that shows a server's game type.]] | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''gameType:''' A string containing a name for the game mode, or ''false'' to clear it. | *'''gameType:''' A string containing a name for the game mode, or ''false'' to clear it. '''(MAX 200 characters)''' | ||
===Returns=== | ===Returns=== |
Latest revision as of 09:30, 3 October 2024
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. (MAX 200 characters)
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" )
Example 2
This example adds a command to change the game type.
function setNewGameType( source, commandName, newGameType ) local oldGameType = getGameType() -- check old Game Type setGameType( newGameType ) -- set new Game Type outputChatBox( "Game Type " .. oldGameType .. " changed to " .. newGameType .. ".", getRootElement(), 255, 128, 0 ) end addCommandHandler( "setgametype", setNewGameType )
See Also