File: SetLeaguePerformance.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (52 lines) | stat: -rw-r--r-- 1,870 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?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>SetLeaguePerformance</title>
    <category>Network</category>
    <subcat>League</subcat>
    <version>5.5 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>score</name>
          <desc>New player or scenario score</desc>
        </param>
        <param>
          <type>int</type>
          <name>player_id</name>
          <desc>ID of player whose score shall be set. If not given, global performance for all players is set.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Sets the league score. This function can be used for custom scenario scoring in competition or adventure leagues.</desc>
    <remark>Use <funclink>GetPlayerID</funclink>() to get the ID of a joined player.</remark>
    <examples>
      <example>
        <code>#appendto Rock
static g_rocks_collected;

func Entrance(clonk)
{
	var plr = clonk-><funclink>GetController</funclink>();
	if (clonk-><funclink>GetID</funclink>() == Clonk &amp;&amp; plr != NO_OWNER)
	{
		++g_rocks_collected;
		<funclink>Log</funclink>("%s found a rock! Score: %d", <funclink>GetTaggedPlayerName</funclink>(plr), g_rocks_collected);
		SetLeaguePerformance(g_rocks_collected);
		return <funclink>RemoveObject</funclink>();
	}
	return <funclink>_inherited</funclink>(clonk, ...);
}</code>
        <text>Rock script modification: Whenever a rock is collected by a Clonk, the score of all players is increased.</text>
      </example>
    </examples>
    <related><funclink>SetLeagueProgressData</funclink><funclink>GetLeagueScore</funclink></related>
  </func>
  <author>Sven2</author><date>2014-04</date>
</funcs>