forked from Mirrors/openclonk
45 lines
1.5 KiB
XML
45 lines
1.5 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>SetPlrKnowledge</title>
|
|
<category>Player</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>int</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>player</name>
|
|
<desc>Player which receives or loses the construction plan. If nil, the function is executed for all players.</desc>
|
|
</param>
|
|
<param>
|
|
<type>id</type>
|
|
<name>definition</name>
|
|
<desc>Id of the definition for which the plan shall be given.</desc>
|
|
</param>
|
|
<param>
|
|
<type>bool</type>
|
|
<name>remove</name>
|
|
<desc>If not <code>false</code>, the plan will be removed from the players knowledge.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Gives a player a construction plan resp. removes the plan if remove is given.</desc>
|
|
<examples>
|
|
<example>
|
|
<code>var i, id; <funclink>while</funclink> (id = <funclink>GetDefinition</funclink>(i++)) SetPlrKnowledge(nil, id);</code>
|
|
<text>All players are given plans to all loaded objects.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>GetPlrKnowledge</funclink>
|
|
<funclink>SetPlrMagic</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Sven2</author><date>2003-06</date>
|
|
</funcs>
|