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

39 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>SetCursor</title>
<category>Player</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>player</name>
<desc>Player number</desc>
</param>
<param>
<type>object</type>
<name>obj</name>
<desc>Object to be selected.</desc>
</param>
<param>
<type>bool</type>
<name>no_select_arrow</name>
<desc>If specified and not <code>false</code>, no cursor arrow is drawn when the object is selected.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Sets the control cursor of a player to the specified object and selects this object for player control. Returns <code>false</code> if the target object is currently deactivated by <funclink>SetCrewEnabled</funclink>.</desc>
<related>
<funclink>GetCursor</funclink>
<funclink>SelectCrew</funclink>
</related>
</func>
<author>jwk</author><date>2002-08</date>
</funcs>