/docs/sdk/script/fn/Buy.xml

 1<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
 2<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
 3<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
 4<funcs>
 5	<func>
 6		<title>Buy</title>
 7		<category>Objekte</category><subcat>Erzeugung</subcat>
 8		<version>4.9.1.0 GWE</version>
 9		<syntax>
10			<rtype>object</rtype>
11			<params>
12				<param><type>id</type><name>idBuyObj</name><desc>ID des Objekttyps, der gekauft wird</desc></param>
13				<param><type>int</type><name>iForPlr</name><desc>Nummer des Spielers, dem das Objekt hinterher geh�rt</desc></param>
14				<param><type>int</type><name>iPayPlr</name><desc>Nummer des Spielers, der den Kauf bezahlt</desc></param>
15				<param><type>object</type><name>pToBase</name><desc>Zielobjekt, in das das neu gekaufte Objekt hineinversetzt wird</desc><optional /></param>
16				<param><type>bool</type><name>fShowErrors</name><desc>Wenn ungleich Null, werden Fehlermeldugnen wie "Kaufen nicht m�glich" aufgrund von Geldmangel angezeigt.</desc><optional /></param>
17			</params>
18		</syntax>
19		<desc>Kauft ein Objekt f�r iForPlr, und zieht iPayPlr Geld ab. Wenn dieser nicht genug Geld oder das Objekt nicht im Heimatbasismaterial hat, wird der Vorgang nicht ausgef�hrt.</desc>
20		<examples>
21			<example>
22				<code>Buy(CNKT, 0, 0, <funclink>FindBase</funclink>(0), 1);</code>
23				<text>Kauft einen Stein in der Basis des ersten Spielers.</text>
24			</example>
25		</examples>
26		<related>
27			<funclink>Sell</funclink>
28			<funclink>GetWealth</funclink>
29			<funclink>GetBase</funclink>
30			<funclink>FindBase</funclink>
31		</related>
32	</func>
33	<author>Sven2</author><date>November 2001</date>
34</funcs>