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

39 lines
1.0 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>SetWealth</title>
<category>Player</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>player</name>
<desc>Player number of the player whose wealth you want to change.</desc>
</param>
<param>
<type>int</type>
<name>value</name>
<desc>New wealth value.</desc>
</param>
</params>
</syntax>
<desc>Sets the wealth value of a player.</desc>
<examples>
<example>
<code>SetWealth(5, 0);</code>
<text>Brankrupts player number six.</text>
</example>
</examples>
<related>
<funclink>GetWealth</funclink>
<funclink>DoWealth</funclink>
</related>
</func>
<author>jwk</author><date>2002-08</date>
</funcs>