forked from Mirrors/openclonk
48 lines
1.7 KiB
XML
48 lines
1.7 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>GetPlrMagic</title>
|
|
<category>Player</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>bool / id</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>player</name>
|
|
<desc>Player whose magic knowledge you want to determine.</desc>
|
|
</param>
|
|
<param>
|
|
<type>id</type>
|
|
<name>id</name>
|
|
<desc>With id specified the function returns <code>true</code>, if the specified player knows the specified spell. In this case index is ignored.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>index</name>
|
|
<desc>With index specified the function returns the indicated spell from the player's list of known spells.</desc>
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Determines magic spell knowledge of a player.</desc>
|
|
<examples>
|
|
<example>
|
|
<code><funclink>if</funclink> (GetPlrMagic(0,Magic_Lightning))
|
|
<funclink>Log</funclink>("Player %s can create lightnings",<funclink>GetPlayerName</funclink>(0));
|
|
</code>
|
|
<text>If player 0 knows the lightning spell, a message is displayed.</text>
|
|
</example>
|
|
<example>
|
|
<code>var spell = GetPlrMagic(0,0,4);
|
|
<funclink>Log</funclink>("The fifth spell of the first player is %i",spell);
|
|
</code>
|
|
<text>Returns the id of the fifth spell of the first player.</text>
|
|
</example>
|
|
</examples>
|
|
</func>
|
|
<author>jwk</author><date>2002-06</date>
|
|
</funcs>
|