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

23 lines
1.0 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>EditCursor</title>
<category>Developer</category>
<version>5.1 OC</version>
<syntax><rtype>object</rtype></syntax>
<desc>In the developer mode of the engine this function returns the object which is currently under the mouse cursor (in edit mode: select and move).</desc>
<examples>
<example>
<code>var cursor = EditCursor();
cursor-&gt;<funclink>Message</funclink>(&quot;%s|x: %d y: %d|xdir: %d ydir: %d&quot;, <funclink>GetName</funclink>(cursor), <funclink>GetX</funclink>(cursor), <funclink>GetY</funclink>(cursor),
<funclink>GetXDir</funclink>(cursor), <funclink>GetYDir</funclink>(cursor));</code>
<text>Displays some information about the object above which the edit cursor is hovering.</text>
</example>
</examples>
</func>
<author>matthes</author><date>2008-04</date>
</funcs>