GetGameType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{Server function}}<!-- Change this to "Client function" or "Server function" appropriately-->
{{Server function}}<!-- Change this to "Client function" or "Server function" appropriately-->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function retrieves the current gametype as set by [[setGameType]].
This function retrieves the current gametype as set by [[setGameType]]. The game type is displayed in the server browser next to the server's name.


==Syntax==  
==Syntax==  
Line 15: Line 15:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example sends a message to player when he joins, if the current game type is Race.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function playerJoinHandler( )
  if getGameType() == "Race" then
      outputChatBox( "Ready... Get set... GO!!", source )
  end
end
addEventHandler( "onPlayerJoin", getRootElement(), playerJoinHandler )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{ASE functions}}
{{Announce functions}}
[[Category:Needs_Example]] <!-- leave this until the example is completed. -->

Latest revision as of 16:18, 30 January 2009

This function retrieves the current gametype as set by setGameType. The game type is displayed in the server browser next to the server's name.

Syntax

string getGameType ()

Returns

Returns the gametype as a string. If no gametype is set it returns nil.

Example

This example sends a message to player when he joins, if the current game type is Race.

function playerJoinHandler( )
   if getGameType() == "Race" then
      outputChatBox( "Ready... Get set... GO!!", source )
   end
end
addEventHandler( "onPlayerJoin", getRootElement(), playerJoinHandler )

See Also