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

42 lines
1.2 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>RemoveAll</title>
<category>Objects</category>
<subcat>Existence</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>array</type>
<name>Criteria</name>
<desc>Search criterion in the form of a Find_* function</desc>
</param>
<param>
<type/>
<name>...</name>
<desc>Additional search criteria in the form of Find_* functions</desc>
<optional />
</param>
</params>
</syntax>
<desc>Removes all objects which are found using the search criteria.</desc>
<examples>
<example>
<code>RemoveAll(<funclink>Find_ID</funclink>(Wipf));</code>
<text>All wipfs will be removed.</text>
</example>
</examples>
<related>
<funclink>RemoveObject</funclink>
<funclink>CreateObject</funclink>
<funclink>FindObjects</funclink>
</related>
</func>
<author>Newton</author><date>2009-07</date>
</funcs>