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

49 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>DoBaseMaterial</title>
<category>Player</category>
<version>1.0 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>player</name>
<desc>Number of the player whose home base material you want to change.</desc>
</param>
<param>
<type>id</type>
<name>definition</name>
<desc>id of the buyable object type you want to adjust.</desc>
</param>
<param>
<type>int</type>
<name>change</name>
<desc>Change of the available amount (positive or negative).</desc>
</param>
</params>
</syntax>
<desc>Changes availability of buyable objects at the home base.</desc>
<examples>
<example>
<code><funclink>DoBaseMaterial</funclink>(0, Firestone, 1);</code>
<text>The player can now buy one flint more.</text>
</example>
</examples>
<related>
<funclink>GetBaseMaterial</funclink>
<funclink>SetBaseMaterial</funclink>
<funclink>GetBaseProduction</funclink>
<funclink>DoBaseProduction</funclink>
<funclink>SetBaseProduction</funclink>
<funclink>Buy</funclink>
<funclink>Sell</funclink>
</related>
</func>
<author>Maikel</author><date>2014-04</date>
</funcs>