openclonk/docs/sdk/script/fn/IsNetwork.xml

26 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>IsNetwork</title>
<category>Global</category>
<version>5.1 OC</version>
<syntax><rtype>bool</rtype></syntax>
<desc>Returns whether the current game is a network game.</desc>
<examples>
<example>
<code>Log("Welcome to the mean and dirty flint melee. Everything is allowed!");
if(<funclink>GetPlayerCount</funclink>() == 2 &amp;&amp; !IsNetwork())
{
Log("Especially looking on your friend's side of the screen and taking away his controls!");
Log("So, don't hold back only because you are %s's guest, %s! :-D", <funclink>GetPlayerName</funclink>(0),<funclink>GetPlayerName</funclink>(1));
}</code>
<text>Displays a sly message based on telltale signs: If there two players in the game and it is not a network game, the round must be played locally on splitscreen only. Probably a friend came over? Also, the first player usually belongs to the person who installed the game.</text>
</example>
</examples>
</func>
<author>jwk</author><date>2002-04</date>
</funcs>