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

23 lines
946 B
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>GetDefBottom</title>
<category>Objects</category>
<subcat>Status</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Determines the lower limit of an object. This corresponds to the bottom vertex on objects that have vertices and y position + DefCore OffsetY + DefCore Height for objects without vertices.</desc>
<examples>
<example>
<code><funclink>Contents</funclink>()-&gt;<funclink>Exit</funclink>(0, GetDefBottom()-<funclink>GetY</funclink>());</code>
<text>Exits the first contained object to the container's bottom center.</text>
</example>
</examples>
<related><funclink>GetY</funclink></related>
</func>
<author>Sven2</author><date>2002-04</date>
</funcs>