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

28 lines
980 B
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>GetLeagueScore</title>
<category>Network</category>
<subcat>League</subcat>
<version>5.5 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>player_id</name>
<desc>ID of player whose score shall shall be returned.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Returns the league score of the given player. This function can be used for custom scoring e.g. in competition leagues.</desc>
<remark>Use <funclink>GetPlayerID</funclink>() to get the ID of a joined player.</remark>
<related><funclink>GetLeagueProgressData</funclink><funclink>SetLeaguePerformance</funclink></related>
</func>
<author>Sven2</author><date>2014-04</date>
</funcs>