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

29 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>ScoreboardCol</title>
<category>Interface</category>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>id</type>
<name>definition</name>
<desc>C4ID to be converted into a scoreboard column index. For object based scoreboards you should always use the id of the object definition which is accessing the scoreboard.</desc>
</param>
</params>
</syntax>
<desc>Converts an object definition id into a number which can be used as index for <funclink>SetScoreboardData</funclink>. This function is of interest if an object script intends to access the scoreboard but wants to be sure that it is not using the same column indices as another object definition.</desc>
<related>
<funclink>SetScoreboardData</funclink>
<funclink>SortScoreboard</funclink>
<funclink>DoScoreboardShow</funclink>
</related>
</func>
<author>Sven2</author><date>2006-02</date>
</funcs>