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

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
	<func>
		<title>Collect</title>
		<category>Objekte</category><subcat>Inhalt</subcat>
		<version>4.9.1.0 GWE</version>
		<syntax>
			<rtype>bool</rtype>
			<params>
				<param><type>object</type><name>item</name><desc>Objekt, das aufgesammelt werden soll</desc></param>
			</params>
		</syntax>
		<desc>Sammelt ein Objekt auf. Der Befehl f<>hrt dieselben Funktionen aus, als w<>re das Objekt durch den normalen Collection-Bereich des Objekts eingesammelt worden (z.B. RejectCollect, Pr<50>fung auf Flagge/Flagge abnehmbar, Hit-Aufruf bei OCF_HitSpeed2, usw.). Die einzigen Unterschiede sind, dass keine Pr<50>fung der Position von item auf den Entrance-Bereich von target/this() gemacht wird, und dass item nicht auf OCF_Carryable gepr<70>ft wird.<br />Mit diesem Befehl l<>sst sich beispielsweise das Aufnehmen von Objekten aus Containern heraus realisieren. Wenn die Aufnahme fehlschlug (Beispielsweise durch den RejectCollect-Aufruf oder weil der Container voll war), gibt die Funktion 0 zur<75>ck. Ansonsten 1.</desc>
		<examples>
			<example>
<code>protected func ControlDig (clonk)
{
	var obj; if (!(obj = <funclink>Contents</funclink>())) <funclink>return</funclink> 1;
	if (!clonk->Collect(obj)) clonk-><funclink>Message</funclink>("Herausnehmen nicht m<>glich");
	<funclink>return</funclink> 1;
}
</code>
				<text>Auf Graben wird das erste Inhaltsobjekt an den ausgew<65>hlten Clonk <20>bergeben.</text>
			</example>
		</examples>
		<related>
			<funclink>Enter</funclink>
		</related>
	</func>
	<author>Sven2</author><date>Mai 2002</date>
</funcs>