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

42 lines
1.3 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>GetCrew</title>
<category>Objects</category>
<subcat>Crew</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>object</rtype>
<params>
<param>
<type>int</type>
<name>player</name>
<desc>Player number of the player whose crew member will be returned.</desc>
</param>
<param>
<type>int</type>
<name>index</name>
<desc>Crew index of the clonk.</desc>
</param>
</params>
</syntax>
<desc>Returns the indicated crew member of a player. For an invalid index <code>nil</code> is returned.</desc>
<examples>
<example>
<code>var i=<funclink>GetCrewCount</funclink>(0); <funclink>while</funclink> (i--) <funclink>Kill</funclink>(GetCrew(0, i));</code>
<text>Kills all crew members of the first player.</text>
</example>
</examples>
<related>
<funclink>GetCrewCount</funclink>
<funclink>GetHiRank</funclink>
<funclink>GetCursor</funclink>
<funclink>GetCaptain</funclink>
</related>
</func>
<author>Sven2</author><date>2002-05</date>
</funcs>